0ne Record Docs
  • GENERAL OVERVIEW
    • Introduction
    • Before getting started
    • Changelog
    • Status
  • About the API
    • Environments
    • Versionning
      • Breaking change
    • Conditions & Limit
    • Pagination
    • Date Handling
    • Identifier
    • Filtering and Sorting
    • Groups
    • Troubleshooting
  • Security
    • Authentication
    • Authorization
  • REST API
    • Container
      • Get all container
      • Get a container by id
      • Create a container
      • Update a container
      • Delete a container
    • Container Type
      • Get all container type
      • Get a container type by type
      • Create a container type
      • Update a container type
      • Delete a container type
    • Country
    • Place
    • Shipment
      • Get all shipment
      • Get shipment by id
      • Create a shipment
      • Update a shipment
      • Delete a shipment
    • Shipment Anomaly
      • Get all shipment anomaly
      • Get a shipment anomaly by id
      • Create a shipment anomaly
      • Update a shipment anomaly
      • Delete a shipment anomaly
    • Shipment Anomaly Category
      • Get all shipment anomaly category
      • Get a shipment anomaly category by name
      • Create a shipment anomaly category
      • Delete a shipment anomaly category
    • Shipment Anomaly Type
      • Get all shipment anomaly type
      • Get a shipment anomaly type by code
      • Create a shipment anomaly type
      • Update a shipment anomaly type
      • Delete a shipment anomaly type
    • Shipment Customs
      • Get all shipment customs
      • Get shipment customs by id
      • Create a shipment customs
      • Update a shipment customs
      • Delete a shipment customs
    • Shipment Customs Type
      • Get all shipment customs type
      • Get shipment customs type by name
    • Shipment Detail
      • Get all shipment detail
      • Get shipment detail by id
    • Shipment Document
      • Get all shipment document
      • Get shipment document by id
      • Create a shipment document
      • Delete a shipment document
    • Shipment Event
      • Get all shipment events
      • Get shipment event by id
      • Create a shipment event
      • Update a shipment event
      • Delete a shipment event
    • Shipment Event Type
      • Get all shipment event type
      • Get shipment event type by name
    • Shipment Operator
      • Get all shipment operator
      • Get shipment operator by id
      • Create a shipment operator
      • Update a shipment operator
      • Delete a shipment operator
    • Shipment Preparation
      • Get all shipment preparation
      • Get shipment preparation by id
      • Create a shipment preparation
      • Update a shipment preparation
      • Delete a shipment preparation
    • Shipment Security
      • Get all shipment security
      • Get shipment security
      • Create a shipment security
      • Update a shipment security
      • Delete a shipment security
    • Shipment Security Type
      • Get all shipment security type
      • Get shipment security type by code
    • Shipment Service
      • Get all shipment service
      • Get shipment service by id
      • Create a shipment service
      • Update a shipment service
      • Delete a shipment service
    • Shipment Service Type
      • Get all shipment service type
      • Get shipment service type by id
      • Create a shipment service type
      • Update shipment service type
      • Delete a shipment service type
    • Society Subscription
      • Get all society subscription
      • Get a society subscription by id
      • Create a society subscription
      • Update a society subscription
      • Delete a society subscription
  • Notification
    • Webhook
      • Request
      • Restriction & Limitation
      • Supported Authentication Methods
      • Payload signature
    • SocketIO
      • Environments
      • Authentication
      • Authorization
      • Namespaces
        • Shipment Notification Namespace
      • Handling Errors
    • Example payload
      • Shipment payload
      • Shipment event payload
      • Shipment operator
Powered by GitBook
On this page
  • Technical Requirements
  • About One Record API
  • Authentication requirements
  1. GENERAL OVERVIEW

Before getting started

Technical Requirements

One Record API encompasses a series of operations accessible through a standardized web protocol. These operations are callable by applications to request or send information. Applications transmit specific request data, and the API promptly responds with data in a predefined standard format.

Key concepts of REST web services:

  • RESTful services: Representational State Transfer (REST) architecture used to design Hypertext Transfer Protocol (HTTP) based Application Programming Interface (API) based on HTTP methods like GET, POST...

  • JSON data: JavaScript Object Notation (JSON), a format of data interchange used by One Record API.

  • Web Services: service provided by a machine over the internet.

About One Record API

One Record API follows the principles of REST (Representational State Transfer), using HTTP methods such as POST, GET, PUT, PATCH, and DELETE to facilitate CRUD (Create, Read, Update, Delete) operations. This design enables a standardized approach to interact with web services. Each HTTP method corresponds to a specific action:

  • POST for creating new resources,

  • GET for retrieving existing resources,

  • PUT for updating entire or partial resources,

  • DELETE for removing resources.

By following these RESTful principles, One Record API ensures that interactions with the system are consistent and predictable.

Authentication requirements

For interacting with One Record API, applications require a unique clientId and clientSecret. Such keys can be obtained by contacting web@technema.fr.

PreviousIntroductionNextChangelog

Last updated 7 months ago

One Record API uses the to authenticate and authorize applications connecting to it. and gives practical usage examples.

OAuth 2.0 Authorization Framework
Authentication
Authorization