API Keys - Guide

Learn how to create and gerer your key API ReturnEase

Qu'est-ce que the key API ?

the key API allow your applications of se connect en toute security l'API ReturnEase without a reason besoin of connexion utilisateur.

definition

a cle API est a chaîne unique qui authentifie the requests vers l'API ReturnEase, permettant l'acces aux data without connexion.

Avantages some key API

✓Acces securise without share your mot of passe
✓Automatisez the tâches and integrations
✓Contrôle granulaire some permissions
✓Revocation facile without change of mot of passe

Create some key API

La creation d'a cle API ne prend que a few minutes :

1. Access aux settings some key API

in le dashboard, Go to Integrations → API Keys

Access aux key API →

2. Click on 'Create API Key'

Enter a nom somecriptif for your cle (ex : 'Zapier Integration', 'Plugin WooCommerce')

3. Copiez your cle

La cle ne will be displayede qu'a seule times. Copiez-la and sauvegarofz-la in a endroit sûr.

rta_live_7xk9mP2qR8vL3nW5jC4bH6yF1dT9sA0e...

4. Use the key in your application

Add the key to your application or integration following their documentation.

⚠️ Important : Copiez the key now

for some reasons of security, nous ne forrons pas vous remontrer the key complete. Copiez-la and sauvegarofz-la in a endroit sûr.

Utiliser the key API

the key API are useds for authentifier the requests vers l'API ReturnEase.

Authentification

Incluez the key API in l'en-tête Authorization comme a token Bearer :

Exemple of requête cURL :

curl https://api.returnease.eu/v1/returns \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Portees of permissions

the key API can a reason differents permissions :

📖 Lecture

Read return and customer data

📊 Analytics

Access reports and statistics

🔔 Webhooks

Manage webhook configurations

✏️ Écriture

Create and mettre update some returns

Manage API Keys

View the key

View all your key API, leur status and leurs statistiques d'use in le dashboard.

View the key API →

Revoquer the key

You can revoquer a cle API at any time. Revoquez a cle whenque :

Elle a ete compromise or divulguee
Elle n'est more used
Vous la remplacez by a newle cle
An employee left the company

monitor l'use

Track l'use some key API in le dashboard for identify the acces non autorises or the issues.

Best Practices of security

✓

Ne bytagez jamais your key API in some depôts publics or in le code front-end

✓

Use environment variables to store the key, ne the codez jamais en dur

✓

Effectuez a rotation reguliere some key (all the 90 jours)

✓

Use some key differents for differents environnements (development, production)

✓

Ensure l'use some key and Configure some alertes for the templates inhabituels

🚨 Ne faites jamais this

Inclure some key API in du code JavaScript côte customer
Commit some key in the depôts of contrôle of version
Share the mêmes key entre several services

Rate limits

for ensure l'equite and la stabilite, all the key API ont some limits of debit.

Limites actuelthe

⏱️per minute: 60 requests
📅per day: 10 000 requests

If you avez besoin of limits more elevees, contact our support team.

Ready to Automate?

Create your premiere cle API and commencez integrer ReturnEase with your systems

Create API Key