API

Docs and API's for Weasy.io

Welcome to our API documentation.
Using our API you can extend your website, build your own application or create APP's to our marketplace.

Quick Start:
1º Create an weasy.io account
2º Get your API key
3º Start Coding

You API Key can be generated in your dashboard under Settings > API.
Please do not share your API keys with others and store them in secure places.

That's it. We are looking to hear from you.
Any bug or suggestion please contact us.
Happy coding :)


Autentication

In order to authenticate a user through our API, an API key must be used.
All API endpoints are available via HTTPS. HTTP access isn't allowed.

All requests to the API must be authenticated with an API key on the HTTP Authorization header.

X-API-KEY: xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD (this key is only an example)

Our API endpoint is https://api.weasy.io and only accepts requests over https.
The API only supports JSON.


Request example

~ curl -i -X POST \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
https://api.weasy.io/v1/



Request limits

You can perform up to 100 requests per minute. If you exceed this limit, you'll get a 429 Too Many Requests response.


Error Codes & Responses

CODE DESCRIPTION
200 Sucess
401 Access Denied
404 Not found
412 Precondition Failed
413 Payload Too Large
422 Unprocessable Entity
429 Too Many Requests

An error will return JSON in the following format:

{
  "code" : 429,
  "message" : "Too Many Requests"
}



Verbs

VERB DESCRIPTION
GET Used for retrieving resources
POST Used for creating resources
PUT Used for updating resources
DELETE Used for deleting resources.



Pagination

Requests that return multiple rows will be paginated to 25 items by default.
The result payload will have an aditional paging node.

{
  "paging" : {
	"previous" : "https://api.weasy.io/v1/order?limit=50&page=1",
	"next" : "https://api.weasy.io/v1/order?limit=50&page=3"
  }
}