Developers Api Orzame - Introduction

Introduction

The Orzame API allows you interact with Orzame App through a simple REST API.

URI and Environments

Orzame API is hosted on the following base URI:

https://api.orzame.com

There is no sandbox environment but you can test on a free basic account. Please note the limitations of the free plan when testing.

Versioning

The version will be added to the url:

https://api.orzame.com/v1

An example of a complete url of an endpoint, for version 1, would be:

https://api.orzame.com/v1/contacts

Authentication

In order to use the API, you should authenticate your request by including your API key as a bearer token value in headers request:

Authorization: Bearer API_KEY_HERE

The API_KEY is provided through your application, per "Company", if you have more than one company created in the application you will need an API key for each one. You can generate this API_KEY in the company configuration, in the "Api Access" section. Only company owners can generate API keys.

Be sure to keep them secret do not share your API keys in publicly accessible areas such GitHub, client-side code, and so forth.

Format and Headers

Api only supports json format. Make sure you have the following headers set on every request:

Accept: application/json
    Content-Type: application/json

Request Limits

The API has a limit of 60 requests per minute per company account between all its apps or per user.

To make it easier to determine if your application is being rate-limited, or is approaching that level, we add the following HTTP headers on our successful responses:

X-RateLimit-Limit
    X-RateLimit-Remaining

If you exceed the limit you will receive a 429 Too Many Requests response. You can check how many seconds you have to wait to make the request again, with the following header:

Retry-After

Request methods

Lists will be paginated and will contain a maximum of 100 results.
By default, if the endpoint documentation does not say otherwise, the lists will be sorted by identifier in descending order, the last created will be the first in the list.
By default, if the endpoint documentation does not say otherwise, the strings will have a maximum length of 255 characters.
For the exchange of information snake_case format variables will be used.
Date and time variables will always return formatted strings according to the ISO 8601 standard.

Requests and variables

Each resource endpoint can support one or more of the following HTTP methods:

POST for resource creation
GET para leer recursos, tanto individuales como colecciones
PATCH for partial resource updates
PUT for full resource updates
DELETE for resource deletion

Errors

Orzame uses conventional HTTP response codes to indicate the success or failure of an API request. The table below contains a summary of the typical response codes:

Code	Description
200	Everything is ok.
201	Created, indicates that the request was successful and led to the creation of a resource.
202	The request has been accepted for processing, but the processing has not been completed.
204	The server successfully fulfilled the request and there is no additional content to return in the response body.
400	Valid data was given but the request has failed.
401	Unauthorized access. No valid API Key was given.
403	Forbidden access. Exists a valid API Key but without enough permissions.
404	The requested resource could not be found.
409	La solicitud no se completó por un conflicto con el estado del recurso o una regla de negocio.
422	The payload has missing required parameters or invalid data was given.
429	Too many attempts.
500	Request failed due to an internal error.
503	Application is offline for maintenance.

Ask us

If you need help, send us an email with information about what you are doing, what you tried and what went wrong, also if you need to do something which is not yet possible to do through the API, we will do our best to help you.