Sign Up
Sign Up

Theme switcher

Welcome to Zembra API Documentation

Zembra provides a RESTful API that supports common HTTP verbs and returns JSON-formatted responses with common HTTP status codes.

You can use the sandbox token and endpoints for testing. The sandbox environment is isolated and will not impact your account balance. Nevertheless, the same rate limiting applies to both live and sandbox environments combined. The sandbox randomly returns dummy data representing all different expected responses from an endpoint. The sandbox performs the same set of validation the live box does, including slug validation and eligibility for services.

Default rate limiting is set to 100 requests per minute. This limit may vary based on your account settings. If unsure, contact your account manager or reach out to our support team.

Each response returned by the API has rate limiting info added to the headers:

  • X-RateLimit-Limit: 100 or -1 if no limit.
    The allocated rate limit to the account.
  • X-RateLimit-Remaining: < 100 or -1 if no limit.
    The number of remaining calls before hitting the rate limiting limit and start getting calls rejected until the counter is reset.

Zembra has made SDKs available in many coding languages to help you quickly get started consuming the API with minimum effort:

You can also download Postman then import this collection which includes calls the all Zembra API sandbox endpoints with a combination of all available parameters.

Was this section helpful?

What made this section unhelpful for you?

Base URL

Zembra Live API:

https://api.zembra.io

Zembra Sandbox API:

https://sandbox.zembra.io

Language Box

Was this section helpful?

What made this section unhelpful for you?

Accommodation

Fetch hotel and other properties availability, details, and quotes.

Account

Get account info

Batch

Submit one batch of up to 1,000 requests per service

Was this section helpful?

What made this section unhelpful for you?

Create Batch

Instead of running parallel requests or looping over your records and submitting one request at a time, you can choose to submit up to 1,000 requests in bulk. The server will pre-validate the inputs and accept all valid requests from the batch.

Every request included in the batch will be processed and its result stored and if applicable delivered to your listeners. You can always retrieve the output of each request individually.

To prevent congestion, you can only submit 1 batch per minute.

Same options from the original endpoint can be used. Example, for [POST] /batch/listing/details your payload will look like this [{"network": "google", "slug": "my-listing"}].

Below is the mapping of batch endpoints to regular endpoints:

Batch Endpoint Original Endpoint
/batch/listing/details [GET] /listing/{network}
/batch/listing/find [GET] /listing/find
/batch/listing/match [GET] /listing/match
/batch/reviews [POST] /reviews
/batch/social/details [POST] /social/{network}/{resource}/{slug}
/batch/social/job [POST] /social/job/{network}/{resource}/{slug}/{content}
/batch/social/subscription [POST] /social/subscription/{network}/{resource}/{slug}/{content}

Header Parameters

Authorizationstring

Path Parameters

servicestring Required

One of the major service categories.

Enum values:
listingreviewssocial
sub-servicestring Required

The specific endpoint alias.

Enum values:
findmatchdetailssubscriptionjob

Body Parameters

networksarray

Show child attributes

networkstring
namestring
addressstring
slugstring
resourcestring
contentstring

Response

201
Object
Batch has been created successfully

Response Attributes

messagestring
datastring

Show child attributes

400
Object
Invalid parameter

Response Attributes

messagestring
401
Object
Invalid token used to authenticate the call

Response Attributes

messagestring
403
Object
The requested network is not enabled for your account. Contact your account manager or our support team to get it added to your list of enabled platforms.

Response Attributes

messagestring
Was this section helpful?

What made this section unhelpful for you?

POST

/batch/{service}/{sub-service}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 curl --location 'https://api.zembra.io/batch/reviews/subscription' \ --header 'Authorization: Bearer {token}' \ --data '[ { "networks": [ "" ], "network": "", "name": "", "address": "", "slug": "", "resource": "", "content": "" } ]'

Response

{
  "message": "Batch accepted",
  "data": {
    "batchId": "2b64a61e-adfe-4daa-8c25-3219ccbc9600"
  }
}
Was this section helpful?

What made this section unhelpful for you?

Get Batch Status

This endpoint will provide details about the batch like requested time, overall progress, list of completed requests, etc.

Header Parameters

Authorizationstring

Path Parameters

batchIdstring Required

The generated batchID that was returned by the API when the batch was submitted.

Maximum
36

Response

200
Object
Successfully returning the batch summary

Response Attributes

messagestring
dataobject

Payload with a list of executable API requests

Show child attributes

401
Object
Invalid token used to authenticate the call

Response Attributes

messagestring
404
Object
Not found

Response Attributes

messagestring
410
Object
Expired Batch

Response Attributes

messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/batch/{batchId}

Select
1 2 curl --location 'https://api.zembra.io/batch/2b64a61e-adfe-4daa-8c25-3219ccbc9600' \ --header 'Authorization: Bearer {token}'

Response

{
  "message": "Batch record found",
  "data": {
    "batchId": "2b64a61e-adfe-4daa-8c25-3219ccbc9600",
    "requestedAt": "2022-09-26T09:08:09.000Z",
    "finishedAt": "2022-09-26T09:08:09.000Z",
    "status": "success",
    "total": 1000,
    "completed": 1000,
    "percentage": 100,
    "breakdown": {
      "scheduled": {
        "count": null,
        "list": [
          1,
          14,
          56
        ]
      },
      "progress": {
        "count": null,
        "list": [
          2,
          38,
          556
        ]
      },
      "success": {
        "count": null,
        "list": [
          3,
          65
        ]
      },
      "failed": {
        "count": null,
        "list": []
      },
      "canceled": {
        "count": null,
        "list": [
          4
        ]
      }
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

Get Batch Entry Result

Get the status and, if completed, the result of a request.

Header Parameters

Authorizationstring

Path Parameters

batchIdstring Required

The generated batchID that was returned by the API when the batch was submitted.

Maximum
36
requestIndexinteger Required

The index of the request from the originally submitted array. The index starts from 1 and can be at most 1000 where 1 stands for the first request.

Minimum
1
Maximum
1000

Response

200
Object
Successfully returning the request result

Response Attributes

messagestring
datastring

Show child attributes

401
Object
Invalid token used to authenticate the call

Response Attributes

messagestring
404
Object
Not found

Response Attributes

messagestring
410
Object
Expired Batch

Response Attributes

messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/batch/{batchId}/{requestIndex}

Select
1 2 curl --location 'https://api.zembra.io/batch/2b64a61e-adfe-4daa-8c25-3219ccbc9600/123' \ --header 'Authorization: Bearer {token}'

Response

{
  "message": "Batch request record found",
  "data": {
    "status": "failed",
    "request": {
      "name": "My listing",
      "network": "google"
    },
    "result": {
      "code": 200,
      "body": {
        "status": "SUCCESS",
        "message": "Successful operation",
        "elapsed": "200 ms",
        "data": {}
      }
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

Get Batch List

Get the list of all the batches previously accepted.

Header Parameters

Authorizationstring

Query Parameters

limitinteger

Maximum number of batches to be returned. At most 100 batches will be returned even if this parameter is set to a higher value.

Minimum
1
Maximum
100
Default value
100
offsetinteger

Helps with pagination. It controls the offset to be applied to the set of batches.

Minimum
1
sortBystring

Indicates the desired sorting attribute.

Default value
timestamp
Enum values:
timestampservicestatus
sortDirectionstring

Indicates the desired sorting direction.

Default value
DESC
Enum values:
ASCDESC
servicestring

Filter results to only batches that match the requested service.

Enum values:
listingreviewssocial
subServicestring

Filter results to only batches that match the request sub-service.

Enum values:
findmatchdetailssubscriptionjob
statusstring

Filters by batch status.

Enum values:
scheduledprogresssuccesspartialfailedcanceled

Response

200
Object
Successfully returning the list of batches

Response Attributes

messagestring
datastring

Show child attributes

400
Object
Invalid parameter

Response Attributes

messagestring
401
Object
Invalid token used to authenticate the call

Response Attributes

messagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/batches?limit=100&offset=100&sortBy=service&sortDirection=ASC&service=reviews&subService=subscription&status=success

Select
1 2 curl --location 'https://api.zembra.io/batches?limit=100&offset=100&sortBy=service&sortDirection=ASC&service=reviews&subService=subscription&status=success' \ --header 'Authorization: Bearer {token}'

Response

{
  "message": "List of batches",
  "data": {
    "total": 890,
    "returned": 100,
    "batches": [
      {
        "batchId": "2b64a61e-adfe-4daa-8c25-3219ccbc9600",
        "requestedAt": "2022-09-26T09:08:09.000Z",
        "finishedAt": "2022-09-26T09:08:09.000Z",
        "status": "success",
        "total": 1000,
        "completed": 1000,
        "percentage": 100,
        "breakdown": {
          "scheduled": {
            "count": null,
            "list": [
              1,
              14,
              56
            ]
          },
          "progress": {
            "count": null,
            "list": [
              2,
              38,
              556
            ]
          },
          "success": {
            "count": null,
            "list": [
              3,
              65
            ]
          },
          "failed": {
            "count": null,
            "list": []
          },
          "canceled": {
            "count": null,
            "list": [
              4
            ]
          }
        }
      }
    ]
  }
}
Was this section helpful?

What made this section unhelpful for you?

Listing

Search, match, and get details for a specific listing

Reviews

Get reviews data as an instant snapshot of its current state without updates

Social Media

Status

Return the status of each supported platform.