# README

Go API client for api

Managing and sending Shipment-, Transport- and Equipment-events and subscriptions for Track & Trace (T&T). API specification issued by DCSA.org. For explanation to specific values or objects please refer to the Information Model v3.3 Polling can be done on the GET /events endPoint. DCSA version 2.2.0

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 1.0.3
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://api-portal.cma-cgm.com/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import api "github.com/buyco/go-cma-sdk/api"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), api.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), api.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), api.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://apis.cma-cgm.net/operation/trackandtrace/v1

Class	Method	HTTP request	Description
EventsApi	GetMoveOnCommercialCycle	Get /events/{trackingReference}	Find Commercial events from unique tracking greference.
EventsApi	SearchMoveOnCommercialCycle	Get /events	Find Commercial events.

Documentation For Models

Documentation For Authorization

ApiKeyAuth

Type: API key
API key parameter name: keyId
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: keyId and passed in as the auth context for each request.

oAuth2

Type: OAuth
Flow: application
Authorization URL:
Scopes:
tandtcommercial:read:be: read access for public enpoints
tandt:read:be: read access for private enpoints
tandtpublic:read:be: read access for public enpoints
tandtcommercial:read:fe: read access for front end public enpoints
tandtpublic:read:fe: read access for front end public enpoints
tandt:read:fe: read access for front end public enpoints

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]