Evyoo POS API v1

Discover what you can read

Discover what you can read

Describes, for YOUR client, the resources it can read, with their fields, filters and sort fields. A resource you have no permission for is not listed, and neither is a field that needs an add-on permission you do not hold.

needs a valid token Getting started

Endpoint#

GET/api/v1/resources

Example request#

bash
curl "https://votre-entreprise.evyooht.com/api/v1/resources" \
  -H "Authorization: Bearer evy_at_votre_jeton"
powershell
$headers = @{ Authorization = "Bearer evy_at_votre_jeton" }
Invoke-RestMethod -Uri "https://votre-entreprise.evyooht.com/api/v1/resources" -Headers $headers
javascript
const response = await fetch("https://votre-entreprise.evyooht.com/api/v1/resources", {
  headers: { Authorization: "Bearer evy_at_votre_jeton" },
});
const data = await response.json();
console.log(data);
php
$ch = curl_init("https://votre-entreprise.evyooht.com/api/v1/resources");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer evy_at_votre_jeton"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);
python
import requests

response = requests.get(
    "https://votre-entreprise.evyooht.com/api/v1/resources",
    headers={"Authorization": "Bearer evy_at_votre_jeton"},
)
print(response.json())

Response#

The resources you can read.

Example response#

json
{
  "data": [
    {
      "name": "invoices",
      "path": "/api/v1/invoices",
      "detail_path": "/api/v1/invoices/{id}",
      "scope": "invoices:read",
      "fields": [
        null
      ],
      "filters": [
        null
      ],
      "sort": [
        null
      ],
      "default_sort": "-date",
      "relations": null
    }
  ]
}

Errors#

The error format and the full list of codes are described in Errors.

StatusWhen
401The token is missing, malformed, expired or revoked (missing_token or invalid_token). Ask for a new token.
429Too many requests this minute. Wait for the number of seconds in the Retry-After header.