Authentication is peformed through a standard OAuth2 Token procedure. A post is made to https://api.starfishetl.com/token, passing in your username & password. A new token is then returned which you will supply to make API calls. You will use the same Username & Password that you use to login Starfish Designer.

Below is an example in Postman:

POST /token

Processes the authentication request and returns a new token.

Request Information

URI Parameters

Name	Description	Type	Additional information
grant_type	Must supply value "password".	string	Required
username	Username, use the same username that you use for designer.starfishetl.com, which is your email address.	string	Required
password	Password, use the same password that you use for designer.starfishetl.com.	string	Required

Response Information

Resource Description

Name	Description	Type	Additional information
access_token	Token you will use in your Authorization (Bearer Token) header for future calls. See below.	string	Length: 512
token_type	"bearer"	string	None
expires_in	Seconds until this token will expire.	long	Default: 5 days

Response Formats

application/json, text/json

Sample:

{
    "access_token": "h3BVjWVMz7deoeDMlfYd_yJj6wONDYv3vr0n7svboONNNB3224nNLR …",
    "token_type": "bearer",
    "expires_in": 431999,
}

Making API Calls

Once you have a valid token, all future API calls must add an "Authorization" HTTP Header of type "Bearer <Token>".

HTTP Header:

Authorization: Bearer h3BVjWVMz7deoeDMlfYd_yJj6wONDYv3vr0n7svboONNNB3224nNLR …