Servers 

The Integration API is specified immediately after the domain using the suffix /integration

https://{hub}.api.seequent.com/integration
PlaceholderValueDescription
hubsbcThe APIM sandbox hostname, in this case representing ‘sandbox Canada’

Authentication and Authorization 

The Seequent Integration API uses mutual authentication. For details, please see the Authentication and Authorization page

Request all links for an integration and an organisation. You need to already have your DV certificate whitelisted and have been identified as a partner with access permissions for the organisation with a Seequent project. As an authorized partner, you should have received the unique org_id and integration_id codes required to make this endpoint call. 

In a successful response, the following will be provided: 

  • operation_link: the link to the location within the Seequent environment 
  • token_link: the link to request a JWT bearer token to provide as secure evidence of access authorization when using the operation_link 

Request 

GET https://sbc.api.seequent.com/integration/{integration_id}/{org_id}/links

Request Parameters 

NameIn RequiredType Description 
integration_id path true string A unique identifier (UUID) for the partner integration, identifying a specific application interacting with Seequent Evo  
org_idpath true string A unique identifier (UUID) identifying a customer who has a Seequent Central instance 

Responses

200 OK: Returns the link objects for each integration for the specified organisation, including a type identifying the specific API integration, a unique link for the operation and a link to use to request a JWT for authorization

    IntegrationLinkObjectResponse: 

      type: object 
      properties: 
        link_id: 
          type: string 
        type: 
          type: string 
        created_at: 
          type: number 
          format: timestamp 
        operation_link: 
          type: string 
          format: url 
        token_link: 
          type: string 
          format: url 

401 No Certificate:

You didn’t provide a certificate with the request

Example

Request

cURL

curl --location --request GET 'https://sbc.api.seequent.com/integration/449be408-3b78-11ec-8d3d-0242ac130003/59b31c08-3b78-11ec-8d3d-0242ac130003/links'

Response

200 OK:

{ 
     "links": [ 
          { 
               "id": "9c348ec0-3b7f-11ec-8d3d-0242ac130003", 
               "type": "file", 
               "created_at": "2021-10-15T03:19:32+00:00", 
               "operation_link": "https://sbc.api.seequent.com/file/companyname/8047fba0-3b8b-11ec-8d3d-0242ac130003/Integrations", 
               "token_link": "https://sbc.api.seequent.com/integration/b647553d-18ff-4fe2-8354-6c93b82137b5/59b31c08-3b78-11ec-8d3d-0242ac130003/links/9c348ec0-3b7f-11ec-8d3d-0242ac130003/token"			
          } 
     ]
} 

You will not be able to use the links directly but will need to make subsequent endpoint calls. First you will need to POST Request a token for authorization using the token_link. Then you will need to make an API call using the operation_link and the authorizing JWT to perform an action, such as using the File API to PUT Request upload link

POST Request a token

Request a signed JSON Web Token (JWT) containing authorization to make certain claims in subsequent API calls. In a successful response, a JWT will be provided. Extract the token to use in additional API calls to prove you, as the requestor, have permission to execute the call. 

Request 

POST  https://sbc.api.seequent.com/integration/{integration_id}/{org_id}/links/{link_id}/token 

Request Parameters 

NameIn RequiredType Description
integration_idpathtruestringA unique identifier (UUID) for the partner integration, identifying a specific application interacting with Seequent Evo
org_id pathtrue string A unique identifier (UUID) identifying a customer who has a Seequent Central instance 
link_id oathtruestringA link_id obtained using the GET Request all links API call 

Response 

     LinkTokenResponse: 
      type: object 
      properties: 
        token: 
          type: string 
          format: jwt 

Example 

Request 

cURL

curl --location --request POST 'https://sbc.api.seequent.com/integration/b647553d-18ff-4fe2-8354-6c93b82137b5/59b31c08-3b78-11ec-8d3d-0242ac130003/links/9c348ec0-3b7f-11ec-8d3d-0242ac130003/token'  

Response

{ 
       "token":       "eyJhbGciOiJIUzUxMiJ9.eyJ0ZXN0IjoiZGF0YSIsIm1vcmUiOiJ0ZXN0ZGF0YSJ9.is9WlhYYRpEW99dJALHLbR6YNswWQOYyuRvdawAwoGB93UwGMKEKNfXsTm1NS2a8Et2J4XpSGCoj5nNoCUfqmAeyJhbGciOiJIUzUxMiJ9.eyJ0ZXN0IjoiZGF0YSJ9.ffw5UZkCDiyKB02KNL1sOyonJsDH2nBWXdbwc_hTNU6b-iunO51LiEFFAo4jvMALAvWEgsHrr_fXcLOxpZ62egeyJhbGciOiJIUzUxMiJ9.eyJ0ZXN0IjoiZGF0YSJ9.2sXABBeTV3xLLPnzSOp7Lxmu7Mf2kTDaLuuZs2pL7Z2DyOgx3oxhQQMZW-F9M0KcgwUXvcpUifFGOErNIcGnRgeyJhbGciOiJIUzUxMiJ9.eyJ0ZXN0IjoiZGF0YSJ9.rLUX3YOw0BnhtAY0tu0WP5bCZVZ3JmUOp3_gzPIjXDvsGFhIk8F-USWBoTTyZ3ma2jSkSX6566rCBo2WPOSn-QeyJhbGciOiJIUzUxMiJ9.eyJ0ZXN0IjoiZGF0YSJ9.qaCqO2eCF2wYrc7_cew3HncUy1GOCrScNAt6jCNxzIjs4iNulEmuDarYM0rO1QL9vkOs330Le8lpYzghMRDJ3g"
} 

The signed JSON Web Token you receive is a short-lived token with a 300 second expiry.