Catalog

The following endpoints allow you to retrieve and manage the integrations.

Get all available data sources

get

/catalog/dataSources

This endpoint will allow you to get a list of all available data sources, including the credential fields required for each.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Responses

200

Successful operation

application/json

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

500

Internal Server Error

application/json

get/catalog/dataSources

GET /catalog/dataSources HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "dataSources": [
    {
      "code": "michelin_connected_fleet",
      "label": "Michelin Connected Fleet",
      "credentials": [
        "username",
        "password",
        "customerId"
      ]
    }
  ]
}

Get all available integrations

get

/catalog/integrations

This endpoint will allow you to get a list of all available integrations.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Responses

200

Successful operation

application/json

204

No Content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

500

Internal Server Error

application/json

get/catalog/integrations

GET /catalog/integrations HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "integrations": [
    {
      "id": 123,
      "name": "MCF France",
      "dataSourceCode": "michelin_connected_fleet",
      "status": "running"
    }
  ]
}

Create an integration

post

/catalog/integrations

This endpoint will allow you to create a new integration.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Body

integrationCredentialsobjectRequired

The credentials to connect to the data source, the content of this object will depend on the data source you want to connect to.

Example: {"username":"user","password":"pass","customerId":"123"}

integrationNamestringRequired

Name of the integration

Example: MCF France

dataSourceCodestringRequired

Code of the data source

Example: michelin_connected_fleet

Responses

200

Successful operation

application/json

integrationIdnumberOptional

The unique identifier of the created integration

Example: 123

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

409

Conflict

application/json

422

Invalid input or missing parameters

application/json

500

Internal Server Error

application/json

post/catalog/integrations

POST /catalog/integrations HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "integrationCredentials": {
    "username": "user",
    "password": "pass",
    "customerId": "123"
  },
  "integrationName": "MCF France",
  "dataSourceCode": "michelin_connected_fleet"
}

{
  "integrationId": 123
}

Delete an integration

delete

/catalog/integrations/{integrationId}

This endpoint will delete an existing integration. ⚠️ Warning This operation is irreversible.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

integrationIdintegerRequired

The unique identifier of the integration to delete

Example: 123

Responses

200

Successful operation

application/json

integrationIdnumberOptional

The unique identifier of the created integration

Example: 123

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

delete/catalog/integrations/{integrationId}

DELETE /catalog/integrations/{integrationId} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "integrationId": 123
}

Update an integration

patch

/catalog/integrations/{integrationId}

This endpoint will allow you to update an existing integration.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

integrationIdintegerRequired

The unique identifier of the integration

Example: 123

Body

integrationCredentialsobjectOptional

The new credentials to connect to the data source, the content of this object will depend on the data source you want to connect to.

Example: {"username":"user","password":"pass","customerId":"123"}

integrationNamestringRequired

The new name of the integration

Example: MCF France

Responses

200

Successful operation

application/json

integrationIdnumberOptional

The unique identifier of the updated integration

Example: 123

integrationNamestringOptional

Name of the updated integration

Example: MCF France

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

409

Conflict

application/json

422

Invalid input or missing parameters

application/json

500

Internal Server Error

application/json

patch/catalog/integrations/{integrationId}

PATCH /catalog/integrations/{integrationId} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "integrationCredentials": {
    "username": "user",
    "password": "pass",
    "customerId": "123"
  },
  "integrationName": "MCF France"
}

{
  "integrationId": 123,
  "integrationName": "MCF France"
}

Activate an integration

post

/catalog/integrations/{integrationId}/activate

This endpoint will activate an existing integration.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

integrationIdintegerRequired

The unique identifier of the integration to activate

Example: 123

Responses

200

Successful operation

application/json

integrationIdnumberOptional

The unique identifier of the created integration

Example: 123

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

post/catalog/integrations/{integrationId}/activate

POST /catalog/integrations/{integrationId}/activate HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "integrationId": 123
}

Deactivate an integration

post

/catalog/integrations/{integrationId}/deactivate

This endpoint will deactivate an existing integration.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

integrationIdintegerRequired

The unique identifier of the integration to deactivate

Example: 123

Responses

200

Successful operation

application/json

integrationIdnumberOptional

The unique identifier of the created integration

Example: 123

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

post/catalog/integrations/{integrationId}/deactivate

POST /catalog/integrations/{integrationId}/deactivate HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "integrationId": 123
}

PreviousContracts NextKafka API

Last updated 26 days ago

Was this helpful?