This article gives an overview of the different APIs available in Link and the prerequisites on how to use them.
Authentication
OAuth
Client/Secret
UI URL: [CustomerName]-[Environment]-link.bizbrains.com/identity/clients
In order to use OAuth, the necessary client(s) must be created in Link. When selecting scopes it is required that API is selected.
Token URL: [CustomerName]-[Environment]-api-link.bizbrains.com/connect/token
Use the above URL to request a new access token.
Resource Owner
A resource owner is another term for a standard Link user with the necessary role(s) for the given API.
Typically a “service user“ is created. This is a Link user created with the sole purpose of interacting with Link APIs.
Personal Access Token
Personal access tokens are created directly on a user’s details page in Link.
See the following article (Personal Access Token (PAT)) for a more detailed description of this authentication type.
Link APIs
See for the swagger for an overview of all available endpoints and a brief explanation of what each point does.
Swagger URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/swagger/index.html
Navigating between Link API swagger documentations is done by change definition as shown below.
Link Inbox/Outbox
Inbox
Purpose: An endpoint to deliver a message to Link for processing. The request will contain the message itself and any relevant metadata.
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/transport/inbox
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API Transport
Outbox
Purpose: A series of endpoints used to create an outbound flow from Link to an end-system.
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/transport/outbox
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API Transport
Link REST
Configuration
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/rest/configuration
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API Configuration View
ConversionTable
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/rest/conversions
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API ConversionTable View
Document
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/rest/entities/document
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API Document View
Tracking
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/rest/operation/tracking
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API Tracking
Developing with Bizbrains.Link.Api.Proxy
Link3Public Nuget URL: https://bizbrains-productteam.visualstudio.com/Link3Public/_artifacts/feed/Link3Public
In the Link3Public feed there is a package called Bizbrains.Link.Api.Proxy which helps facilitate communication with the Link REST API.
Link AS2
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/transport/as2
Authentication type(s): None
Link AS4
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/transport/as4
Authentication type(s): None
Generic Http Handler
If there is a more specific action that is not supposed by any of the above APIs out of the box, then there is the option of creating a plugin for the generic http handler.
See the following article (Generic Http Handler ) for more details.