Activité

Server

Enregistrer et gérer les activités membre (ex. achats, transferts, visites...) pour automatiser les récompenses. Les points de terminaison sont limites a 10 requêtes/sec. Voir la documentation des methodes pour les details.

Enregistrer une activité et déclencher le traitement des récompenses.

POST

https://api.otonum.io

/api/v1/partner/activities

Utilisez ce point de terminaison pour enregistrer une activité client. L'opération déclenche la logique de récompense et retourne un identifiant de tâche pour suivre le traitement asynchrone.

Enregistrer une activité et déclencher le traitement des récompenses. › Request Body

ActivityRequest

personalCode

string | null

Code personnel unique identifiant le membre.

type

ActivityType · enum

Enum values:

Purchase

Transfer

Visit

Review

amount

number | null · double

Montant monétaire associé à l'activité.

reference

string | null

Référence unique permettant d'associer cette activité à un système externe ou à un identifiant tiers.

occurredAt

string | null · date-time

Date et heure UTC auxquelles l'activité a eu lieu. Format : ISO 8601.

description

string | null

Optionnel. Fournit du contexte ou des détails supplémentaires sur l'activité.

Optionnel. Détails structurés spécifiques au type d'activité. La forme de cet objet dépend du champ type : utilisez PurchaseDetails quand type est Purchase, TransferDetails quand type est Transfer, VisitDetails quand type est Visit, et ReviewDetails quand type est Review. Omettez ce champ si aucun détail supplémentaire n'est disponible.

redemptionCode

string | null

Optionnel. Code de rédemption associé à l'activité, le cas échéant.

redemptionAmount

number | null · double

Optionnel. Portion du montant à échanger à l'aide d'une récompense ou d'un bon, le cas échéant.

Enregistrer une activité et déclencher le traitement des récompenses. › Responses

Activité enregistrée et traitement des récompenses mis en file d'attente.

TaskResponse

taskId

string | null

status

string | null

POST/api/v1/partner/activities

curl https://api.otonum.io/api/v1/partner/activities \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "personalCode": "personalCode",
  "type": "Purchase",
  "amount": 0,
  "reference": "reference",
  "occurredAt": "2024-08-25T15:00:00Z",
  "description": "description",
  "detail": {
    "channel": "Instore",
    "items": [
      {
        "key": "key",
        "name": "name",
        "quantity": 1,
        "unitPrice": 0
      }
    ],
    "terminalId": "terminalId"
  },
  "redemptionCode": "redemptionCode",
  "redemptionAmount": 0
}'

Example Request Body

{
  "personalCode": "personalCode",
  "type": "Purchase",
  "amount": 0,
  "reference": "reference",
  "occurredAt": "2024-08-25T15:00:00Z",
  "description": "description",
  "detail": {
    "channel": "Instore",
    "items": [
      {
        "key": "key",
        "name": "name",
        "quantity": 1,
        "unitPrice": 0
      }
    ],
    "terminalId": "terminalId"
  },
  "redemptionCode": "redemptionCode",
  "redemptionAmount": 0
}

json

Example Responses

{
  "taskId": "taskId",
  "status": "status"
}

text

Application

Api Otonum

Activité

Server

Enregistrer une activité et déclencher le traitement des récompenses.

POST

https://api.otonum.io

/api/v1/partner/activities

Utilisez ce point de terminaison pour enregistrer une activité client. L'opération déclenche la logique de récompense et retourne un identifiant de tâche pour suivre le traitement asynchrone.

Enregistrer une activité et déclencher le traitement des récompenses. › Request Body

ActivityRequest

personalCode

string | null

Code personnel unique identifiant le membre.

type

ActivityType · enum

Enum values:

Purchase

Transfer

Visit

Review

amount

number | null · double

Montant monétaire associé à l'activité.

reference

string | null

Référence unique permettant d'associer cette activité à un système externe ou à un identifiant tiers.

occurredAt

string | null · date-time

Date et heure UTC auxquelles l'activité a eu lieu. Format : ISO 8601.

description

string | null

Optionnel. Fournit du contexte ou des détails supplémentaires sur l'activité.

redemptionCode

string | null

Optionnel. Code de rédemption associé à l'activité, le cas échéant.

redemptionAmount

number | null · double

Optionnel. Portion du montant à échanger à l'aide d'une récompense ou d'un bon, le cas échéant.

Enregistrer une activité et déclencher le traitement des récompenses. › Responses

Activité enregistrée et traitement des récompenses mis en file d'attente.

TaskResponse

taskId

string | null

status

string | null

POST/api/v1/partner/activities

curl https://api.otonum.io/api/v1/partner/activities \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "personalCode": "personalCode",
  "type": "Purchase",
  "amount": 0,
  "reference": "reference",
  "occurredAt": "2024-08-25T15:00:00Z",
  "description": "description",
  "detail": {
    "channel": "Instore",
    "items": [
      {
        "key": "key",
        "name": "name",
        "quantity": 1,
        "unitPrice": 0
      }
    ],
    "terminalId": "terminalId"
  },
  "redemptionCode": "redemptionCode",
  "redemptionAmount": 0
}'

Example Request Body

{
  "personalCode": "personalCode",
  "type": "Purchase",
  "amount": 0,
  "reference": "reference",
  "occurredAt": "2024-08-25T15:00:00Z",
  "description": "description",
  "detail": {
    "channel": "Instore",
    "items": [
      {
        "key": "key",
        "name": "name",
        "quantity": 1,
        "unitPrice": 0
      }
    ],
    "terminalId": "terminalId"
  },
  "redemptionCode": "redemptionCode",
  "redemptionAmount": 0
}

json

Example Responses

{
  "taskId": "taskId",
  "status": "status"
}

text

Application