Les callbacks suivants sont déclenchés par Frisbii Media :
Type de callback | Type d'entité | Entité | Description |
|---|---|---|---|
CREATION | APP_STORE_ORDER | AppStoreOrder | Créer ou mettre à jour une commande existante via un magasin d'applications (Apple ou Google) |
CHANGE | APP_STORE_SUBSCRIPTION | AppStoreSubscription | Envoyé lors de l'activation ou de la désactivation de l'abonnement à l'App Store |
CREATION | APP_STORE_SUBSCRIPTION | AppStoreSubscription | Envoyé lors de la création d'un abonnement à l'App Store |
CHANGE | CUSTOMER | Customer | Envoyé lors de la modification des données relatives au client - par exemple le nom d'utilisateur, le mot de passe, l'e-mail, le nom, le titre, le statut ou d'autres données ou vérifications par jeton. |
CREATION | CUSTOMER | Customer | Envoyé lors de la création ou de l'enregistrement d'un client |
DELETION | CUSTOMER | - | Notification de la suppression d'un client |
CHANGE | CUSTOMER_OPT_IN | OptIns | Envoyé lors de la création ou de la mise à jour de l'opt-in client |
PAYMENT_FAILED | FAILED_PAYMENT | FailedPaymentNotification | Envoyé en cas d'échec du paiement |
CHANGE | INVOICE | Invoice | Envoyé en cas de modification de la facture - annulation, correction, changement de statut |
CREATION | INVOICE | Invoice | Envoyé lors de la facturation |
CREATION | INVOICE_CANCELLATION | Invoice | Envoyé en cas d'annulation de la facture |
CREATION | INVOICE_CORRECTION | Invoice | Envoyé avec la correction de la facture |
CANCELLATION | MULTIUSER_SUBSCRIPTION | MultiuserSubscription | Envoyé lors de l'annulation d'un abonnement multi-utilisateurs |
CREATION | MULTIUSER_SUBSCRIPTION | MultiuserSubscription | Envoyé lors de la création d'un abonnement multi-utilisateurs |
UNDO_CANCELLATION | MULTIUSER_SUBSCRIPTION | MultiuserSubscription | Envoyé lors de l'annulation de la résiliation d'un abonnement multi-utilisateurs |
CREATION | ORDER | Order | Envoyé avec la commande |
CONDITIONS_FULFILLED | PURCHASED_ADDON | PurchasedAddon | Envoyé lors de la commande s'il y a des suppléments achetés |
CANCELLATION | SUBSCRIPTION | Subscription | Envoyé lorsque l'abonnement est annulé |
CHANGE | SUBSCRIPTION | Subscription | Envoyé lorsque l'abonnement est modifié |
CREATION | SUBSCRIPTION | Subscription | Envoyé lors de la création de l'abonnement |
ENDED | SUBSCRIPTION | Subscription | Envoyé à la fin de l'abonnement |
UNDO_CANCELLATION | SUBSCRIPTION | Subscription | Envoyé lors du retrait de la résiliation |
CREATION | CALLBACK_RENEWAL | ApiAccessTokenCallback | Envoyé lors du renouvellement du jeton d'accès à l'API |
💡 Tous les schémas se trouvent dans le document ci-joint.
Note : Les exemples suivants ont pour but de donner une impression exemplaire des données attendues. Toutefois, l'étendue des données peut varier. Avant la mise en ligne, les callbacks doivent être vérifiés sur le système de stage.
Structure générale d'un callback :
{
"entityType" : "CUSTOMER", -> l'entité pour laquelle le callback a été créé (client/facture/abonnement/etc.)
"callbackType" : "CREATION", -> le type de callback correspondant (créer/modifier/supprimer/etc.) "entityId" : "29", - entityId correspond à l'identifiant du client/de la facture/de l'abonnement/etc. en fonction du type d'entité (entityType).
"entityId" : "29", -> entityId correspond à l'ID du client/l'ID de la facture/l'ID de l'abonnement/etc. en fonction de l'entityType
"entity" : { -> les données de l'entité conformément à la documentation de l'API
xxxx
}
}Créer un client :
{
"entityType" : "CUSTOMER",
"callbackType" : "CREATION",
"entityId" : "29",
"entity" : {
"ageVerificationPinEnabled" : false,
"birthday" : null,
"changedBy" : "10001",
"changedByType" : "MERCHANT",
"changedDate" : "2024-08-27T11:49:41.389622Z",
"createdBy" : "10001",
"createdByType" : "MERCHANT",
"createdDate" : "2024-08-27T11:49:41.389622Z",
"customerId" : "29",
"email" : "test.test@frisbii.com",
"externalSystemId" : "",
"firstName" : "Test",
"invoiceEmail" : "",
"language" : "de",
"lastName" : "",
"miscellaneousData" : {},
"mobileNumber" : "",
"registrationDate" : "2024-08-27T11:49:41.389622Z",
"registrationSource" : "Supporter",
"salutation" : "",
"ssoLoginProviders" : null,
"status" : "ACTIVATED",
"twoFactorEnabled" : false,
"username" : "Test"
}
}Créer une facture :
{
"entityType" : "INVOICE",
"callbackType" : "CREATION",
"entityId" : "223",
"entity" : {
"accumulatedPrice" : 0.5,
"analogInvoice" : false,
"cancellationInvoiceId" : 0,
"changedDate" : "2024-08-28T00:08:51.914437Z",
"currency" : "EUR",
"customerEmail" : "frisbii@frisbii.com",
"invoiceAddress" : {
"businessAddress" : false,
"city" : "Kempten",
"country" : "DE",
"firstName" : "Test",
"lastName" : "User",
"postbox" : "48576525",
"postcode" : "87435",
"salutation" : "NONE",
"type" : "INVOICE"
},
"invoiceCustomerId" : "23",
"invoiceDate" : "2024-08-28T00:08:51.868510Z",
"invoiceId" : 223,
"items" : [
{
"changedDate" : "2024-08-28T00:08:51.916800Z",
"createdDate" : "2024-08-28T00:08:51.916800Z",
"deliveryAddress" : {
"businessAddress" : false,
"country" : "DE",
"salutation" : "NONE",
"type" : "DELIVERY"
},
"deliveryCustomerId" : "23",
"discountPercentage" : 0,
"periodEndDate" : "2024-08-29T23:59:59.000000Z",
"periodStartDate" : "2024-08-28T00:00:00.000000Z",
"plenigoOfferId" : "O_D0SO735QL1AXZH7FTG",
"plenigoProductId" : "P_DSQ20PV66PNWGK0LPV",
"plenigoStepId" : "S_O38DOOQI9ZE6DESDWC",
"position" : 1,
"price" : 0.5,
"productId" : "P_DSQ20PV66PNWGK0LPV",
"purchasedAddonId" : 0,
"quantity" : 1,
"subscriptionItemId" : 1230101,
"tax" : 7,
"taxCountry" : "DE",
"taxType" : "DIGITALNEWSPAPER",
"title" : "Angebot A kurzes Abo-Intervall Leistungszeitraum 28.08.2024 - 29.08.2024"
}
],
"orderId" : 0,
"paymentChangedToBilling" : false,
"paymentMethod" : "BILLING",
"paymentMethodId" : 0,
"precursorId" : 0,
"status" : "NOT_PAID",
"successorId" : 0,
"type" : "INVOICE"
}
}Modifier l'abonnement :
{
"entityType" : "SUBSCRIPTION",
"callbackType" : "CHANGE",
"entityId" : "1230116",
"entity" : {
"accessBlocked" : false,
"accountingPeriod" : 0,
"accountingPeriodTimeSpan" : "NONE",
"activePartners" : null,
"analogInvoice" : false,
"cancellationDate" : null,
"cancellationPeriod" : 5,
"cancellationPeriodTimeSpan" : "DAY",
"cancellationReasonUniqueId" : "",
"cancellationType" : "ISSUE_BASED_REGULAR",
"chainId" : 1230116,
"changedBy" : "PLENIGO",
"changedByType" : "SYSTEM",
"changedDate" : "2024-08-28T00:00:07.717485Z",
"chargeableDeliveries" : 8,
"connectedOffer" : false,
"connectedOfferInfo" : null,
"createdBy" : "8",
"createdByType" : "CUSTOMER",
"createdDate" : "2024-08-02T09:43:13.41412Z",
"currency" : "EUR",
"customerCancellationBlocked" : false,
"customerCancellationReasonId" : 0,
"deliveries" : 8,
"deliveryAddressId" : 1230037,
"deliveryCustomerId" : "8",
"deliveryPaused" : null,
"durationPeriod" : 0,
"durationPeriodTimeSpan" : "NONE",
"endDate" : null,
"externalBilling" : false,
"externalSystemId" : "",
"finishedDeliveries" : 4,
"firstBookingDate" : "2024-08-02T09:43:13.348227Z",
"invoiceAddressId" : 1230038,
"invoiceCustomerId" : "8",
"items" : null,
"lastBookingDate" : "2024-08-02T09:43:13.348227Z",
"managedBy" : "PLENIGO",
"managedExternal" : false,
"nextBookingDate" : null,
"openDeliveries" : 4,
"paused" : null,
"paymentMethod" : "CREDIT_CARD",
"paymentMethodDetails" : {
"brand" : "AMERICAN_EXPRESS"
},
"paymentMethodId" : 1230005,
"paymentPaused" : null,
"paymentTriesDone" : 0,
"plenigoOfferId" : "O_628IU8F9CB7I6EH5ZG",
"precursorId" : 0,
"precursorReason" : "",
"precursorReasonDetail" : "",
"purchaseOrderIndicator" : "",
"recurringDeliveries" : false,
"referenceStartDate" : "2024-08-02T00:00:00Z",
"startDate" : "2024-08-02T09:43:13.348191Z",
"status" : "ACTIVE",
"subscriptionId" : 1230116,
"subscriptionType" : "ISSUE_BASED",
"successorId" : 0,
"successorReason" : "",
"successorReasonDetail" : "",
"suppressInvoiceSending" : false,
"term" : 0,
"termTimeSpan" : "NONE"
}
}Supprimer le client :
{
"entityType" : "CUSTOMER",
"callbackType" : "DELETION",
"entityId" : "33",
"entity" : null
}entityId est le numéro du client. Entity = données traitées, ici zéro, car les données concernées ont été supprimées.
Créer un abonnement in-app :
{
"entityType" : "APP_STORE_SUBSCRIPTION",
"callbackType" : "CREATION",
"version" : "3.0",
"entityId" : "1230306",
"entity" : {
"accessRightUniqueId" : "inappsub",
"appStoreSubscriptionId" : 1230206,
"cancellationDate" : "null",
"chainId" : 1230206,
"changedBy" : "2VYpOnyFbem8IWY9DyoVaLgOAuG",
"changedByType" : "API",
"changedDate" : 2023-12-29T15:02:05.353082Z",
"customerId" : "29",
"endDate" : "2023-12-29T15:06:32.364Z",
"externalSystemId : "subscription_1_app_2",
"startDate" : "2023-12-29T15:01:34.393Z",
"status" : "ACTIVE"
}
}