Skip to content

Latest commit

 

History

History
319 lines (260 loc) · 24.2 KB

README.md

File metadata and controls

319 lines (260 loc) · 24.2 KB

amn-o2c-sdk

Michelin North America Order-to-Cash APIs for dealers

  • API version: 1.0.0

  • Generator version: 7.10.0

These APIs will help you to do business transactions with Michelin.

Authentication details:

Option A: OAuth2 Client Credentials (recommended)
Option B: API Key + Basic Authentication (not recommended)

To request your access, please contact your representative.

Our services are based on the EDIWHEEL standards.
You can find more information on the <a href="https://www.ediwheel.com/\" target="_blank">EDIWHEEL website.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependencies>
  ...
  <dependency>
    <groupId>com.michelin.adk.amn.o2c</groupId>
    <artifactId>amn-o2c-sdk</artifactId>
    <version>v1.0.0</version>
    <scope>compile</scope>
  </dependency>
  ...
</dependencies>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'amn-o2c-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'amn-o2c-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.michelin.adk.amn.o2c:amn-o2c-sdk:v1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/amn-o2c-sdk-v1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.michelin.adk.amn.*;
import com.michelin.adk.amn.auth.*;
import com.michelin.adk.amn.o2c.model.*;
import com.michelin.adk.amn.o2c.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://indus.api.michelin.com");
        
        AuthenticationApi apiInstance = new AuthenticationApi(defaultClient);
        String grantType = "grantType_example"; // String | 
        String clientId = "clientId_example"; // String | 
        String clientSecret = "clientSecret_example"; // String | 
        try {
            AuthenticationTokenResponse result = apiInstance.idpV2B2bOauth2TokenPost(grantType, clientId, clientSecret);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#idpV2B2bOauth2TokenPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://indus.api.michelin.com

Class Method HTTP request Description
AuthenticationApi idpV2B2bOauth2TokenPost POST /idp/v2/b2b/oauth2/token Obtain a token to consume the other APIs.
DeliveryApi desadvAmnC10DesadvPost POST /desadv/amn/C1_0/desadv Obtain your Despatch Advices information
InvoiceApi invoiceAmnB34InvoicesPost POST /invoice/amn/B3_4/invoices Get your invoices list.
OrderApi orderAmnC11CreatePost POST /order/amn/C1_1/create Create a new order.
OrderApi orderAmnC11StatusPost POST /order/amn/C1_1/status Obtain the status of your orders
StockApi stockAmnC11InquiryPost POST /stock/amn/C1_1/inquiry Stock inquiry for the quote of given products

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apikey

  • Type: API key
  • API key parameter name: apikey
  • Location: HTTP header

basicAuth

  • Type: HTTP basic authentication

oAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]