Get Started with Jet API

The Signiant Jet API is available for Early Access to Jet users allowing job creation in a development environment.

Before you can work with the Jet API, you must request client_id and client_secret credentials from your Signiant representative.

Read the Jet API documentation on SwaggerHub

Authentication

To use the Jet API, you must have a client_id and client_secret in order to create an OAuth token.

To generate an OAuth token:

1. Ensure your computer can connect to all cloud.signiant.com domains by allowing firewall access to *.cloud.signiant.com.

2. Create a new JSON file specifying your Jet login credentials, client_id, client_secret, and request for a password grant:

{
  "username": "user@example.com",
  "password": "********",
  "client_id": "<your client_id>",
  "client_secret": "<your client_secret>",
  "grant_type": "password"
}

3. Save the file as credentials.json.

4. In your terminal or command prompt, navigate to the directory where credentials.json is saved.

5. Use the curl utility to call the /oauth/token endpoint:

> curl -X POST -H "Content-Type: application/json" --data @credentials.json https://platform-api-service.services.cloud.signiant.com/oauth/token

After completing the request, the application returns an OAuth token that is used to authenticate your API requests:

{
  "access_token": "<access_token>",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Note: OAuth tokens expire 24 hours after they are created.

Creating a Job

The following procedure outlines how to create a Hot Folder job that will automatically transfer all contents from a source to a destination on an ongoing basis. For information about creating a job that accepts manual transfer requests, see Triggerless Jobs.

To create a Hot Folder job:

1. Send a GET request to /v1/endpoints to retrieve a list of your endpoints.

> curl -X GET -H "Authorization: Bearer <token>" -H "Content-Type: application/json" https://platform-api-service.services.cloud.signiant.com/v1/endpoints

2. Using the response body, determine the endpointId of the source and destination endpoints.

3. Use the endpointId, url, and name properties to set the endpoint, file path, and storage profile name for the source and destination objects in the request body actions array.

4. Include the source data object, including its endpointId, url, and name in the triggers array.

5. Send the request body to the /v1/jobs endpoint to create the job.

The response body contains the complete job body, including the jobId, which can be used to pause, resume, or delete a job via the /jobs/{jobId} endpoint.

For more information see the Jet API documentation on SwaggerHub.

Hot Folder Job Request Example

The following example includes the minimum amount of data required to create a Hot Folder transfer job using the Jet API.

Note: The data object source for actions and triggers must match.

{
  "name": "Example Transfer Job",
  "actions": [
    {
      "type": "TRANSFER",
      "data": {
        "source": {
          "url": "file:///C:/path/to/source",
          "endpointId": "12345678-abcd-1234-abcd-123456789123",
          "name": "source"
        },
        "destination": {
          "url": "file:///path/to/destination",
          "endpointId": "12345678-abcd-1234-abcd-123456789123",
          "name": "destination"
        }
      },
      "triggers": [
        {
          "type": "HOT_FOLDER",
          "data": {
            "source": {
              "url": "file:///path/to/source",
              "endpointId": "12345678-abcd-1234-abcd-123456789123",
              "name": "source"
            }
          }
        }
      ]
    }
  ]
}