docs.retraced.com Open in urlscan Pro
2606:4700::6812:5a2  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Skip to main content

retraced API
v1
 * next
 * v1
 * v0



 * Introduction
 * API
 * Integration Guideline

 * 
 * Introduction

On this page


THE RETRACED API

The retraced API comprises all publicly enabled options to make
machine-to-machine changes in the retraced platform: http://retraced.com/. The
retraced dashboard uses the same endpoints, but also in addition more. If you
wish to use the API of the dashboard, it is possible but not versioned cleanly
like the public API.


VERSIONING

The API is versioned using semantic-release rendering numbers like x.y.z (to be
read like major.minor.patch). The major version indicates breaking changes, the
minor version non-breaking feature changes or additions, and the patch version
internal non-breaking adjustments for internal CI/CD and devops purposes.


EXTERNAL IDENTIFIER

This API does support being called with your custom identifier (like a SAP ERP
ID, Infor Syteline ID).


AUTHENTICATION

The authentication procedure is passwordless and you have 2 possible
authentication methods (Access Token and API Key). All calls are authenticated
either with the access token or api key.


 * ACCESS TOKEN
   
   From retraced dashboard You need to request the access code with a registered
   email. You will receive within 2 minutes the email with the code to submit
   again. On successful submission, you are logged in and you get an access
   token and refresh token (you may extract them from any request in network tab
   in developer tools). The access token is the one you need to use to get
   authenticated.


 * API KEY
   
   retraced already shipped an api key for you. You can set it directly in
   request headers. You are free to generate a new api key using api key create
   endpoint; however, this api create request itself should be authenticated
   either by the api key shipped to you or by the access token you get from the
   dashboard as clarified.
   
   To Authenticate using an api key, you need to set it in request headers,
   having the key as companyapikey and the value should be the api key you
   received

Further information on authentication can be found in Authentication endpoints
section.


GETTING STARTED

retraced has 2 environments against which you can send your requests and receive
the expected response, staging and production. We recommend using staging for
your development and testing purposes and production for your production
environment. URLs to both environments are mentioned in each request
description.


 * GET AUTHENTICATED

1- In order to start using the API, you need to authenticate yourself first in
one of the two ways described in Authentication section

2- After getting your access token/api key, you need to set it in every request
header after that.

Next
API
 * Versioning
 * External identifier
 * Authentication
   * Access Token
   * API Key
 * Getting Started
   * Get Authenticated

Copyright © 2024 retraced GmbH. Built with ❤️.