Skip to content

API Common Specifications

Jump to bottom
phhuang102i edited this page Jul 3, 2023 · 16 revisions

API Common Specifications

Domain name

  • Make sure to use the correct domain name for each endpoint.

    domain name endpoint
    api.omnisegment.com https://api.omnisegment.com/api/v1/interaction-report/
    https://api.omnisegment.com/api/v1/tracking-event-report/
    https://api.omnisegment.com/api/v1/products/import-event-registration-data/
    https://api.omnisegment.com/api/v1/products/import-product-guarantee-data/
    https://api.omnisegment.com/api/v1/products/import/
    https://api.omnisegment.com/api/import-gift-voucher/
    https://api.omnisegment.com/omnidata/show-market-report/
    https://api.omnisegment.com/api/import-purchase-data/
    https://api.omnisegment.com/ma_audience/import-audience/
    https://api.omnisegment.com/api/v1/beacon/track-event/

Authentication

  • Make sure to comply with our authentication mechanism

    authentication endpoint example
    header with key X-OmniSegment-Api-Key https://api.omnisegment.com/api/v1/interaction-report/
    https://api.omnisegment.com/api/v1/tracking-event-report/
    https://api.omnisegment.com/api/v1/beacon/track-event/
    		"X-OmniSegment-Api-Key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    body with key api_key https://api.omnisegment.com/api/v1/products/import-event-registration-data/
    https://api.omnisegment.com/api/v1/products/import-product-guarantee-data/
    https://api.omnisegment.com/api/v1/products/import/
    https://api.omnisegment.com/api/import-gift-voucher/
    https://api.omnisegment.com/omnidata/show-market-report/
    https://api.omnisegment.com/api/import-purchase-data/
    https://api.omnisegment.com/ma_audience/import-audience/     		"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Rate limit

  • Here is the list of the rate limit for each endpoint. If you exceed the allowed rate limit, the API may return 429 (Too Many Requests) error code. Please ensure that your requests to the API are within the specified rate limit.

    rate limit endpoint
    10 requests per second https://api.omnisegment.com/api/v1/interaction-report/
    https://api.omnisegment.com/api/v1/tracking-event-report/
    https://api.omnisegment.com/api/v1/products/import-event-registration-data/
    https://api.omnisegment.com/api/v1/products/import-product-guarantee-data/
    https://api.omnisegment.com/api/v1/products/import/
    https://api.omnisegment.com/api/import-gift-voucher/
    https://api.omnisegment.com/omnidata/show-market-report/
    https://api.omnisegment.com/api/import-purchase-data/
    https://api.omnisegment.com/ma_audience/import-audience/
    https://api.omnisegment.com/api/v1/beacon/track-event/

General response format

  • Success response format

    {"SUCCESS": true, "PAYLOAD": "xxxxxx"}
    • Note:
      • the value of key PAYLOAD is the result of called api, and the value depends on each api specification
      • include the status code (200)

  • Fail response format

    {"SUCCESS": false, "ERR_MSG": "xxxxxx"}
    • Note:
      • the value of key ERR_MSG is the result of called api, and the value depends on each api specification
      • include the status code (400, 403, 500)

Error response status code handbook

  • 502 Bad Gateway 503 Service Unavailable 504 Gateway timeout

    If you receive one of the above status codes, retry again every five minutes until getting other status code or having retried over five times.

Clone this wiki locally