Static Operations API

Access the Static Operations API

Static Operations

You can access the Static Operations API by clicking this link.

To sign up to the Static Operations API:

Static Operations

1. Access the Static Operations API
2. Click the Sign up link at the top right corner.



The Sign up window is displayed.



3. Enter the mandatory information.
4. Click Sign up.

An email verification is sent to your email address. It contains a verification link.

5. Follow the instructions from the email to verify your account.

Once this is done, you are brought to the sign up page of the Static Operations API.

To sign in to the Static Operations API:

Static Operations

1. Access the Static Operations API
2. Click the Sign in link at the top right corner.



The Sign in window is displayed.



3. Enter your credentials.
4. Click Sign in.

The Static Operations API portal main page is displayed. As you can see, you have access to different options in the menu.



The next step is to subscribe to one product.

To subscribe to a product:

Static Operations

1. Sign In to the Static Operations API
2. Click the Products menu link.



The Products page is displayed. It lists all the products to which you are subscribed.



3. Click the Broadsign Static Operations product name.

The Broadsign Static Operations product page is displayed. It lists all your subscriptions, if you have any.



The page also lists the APIs that are available under the Broadsign Static Operations product.

API	Description
Authentication API	API to authenticate users in Broadsign Static Operations.
Inventory Management	API to manage the static inventory in the Broadsign Static Operations.
Operations Management	API to manage the static operations in the Broadsign Static Operations.

4. Create a subscription to the Broadsign Static Operations product by entering a name for your subscription in the field under Your subscriptions, then click Subscribe.



Broadsign must approve your subscription. You will receive a confirmation email once your subscription is approved.

Once your subscription is approved, your user profile page will display the Subscription information.



You must now generate an authentication token.

To retrieve a JWT for Authentication:

Static Operations

1. Sign In to the Static Operations API
2. Click the APIs menu link.



The Products page is displayed. It lists all the products to which you are subscribed.



3. Click the Broadsign Static Operations product name.

The Broadsign Static Operations product page is displayed. It lists all your subscriptions, if you have any.



The page also lists the APIs that are available under the Broadsign Static product.

4. Click the Authentication API link.

The Authentication API page is displayed. It has one endpoint, the GenerateAccessToken endpoint.



5. Click the Try this operation button.

The Authorization information is displayed.



6. Scroll down to the Headers section, and enter your Subscription key in the Ocp-Apim-Subscription-Key field.



7. Scroll down to the Body section, and enter your credentials in the text field.



8. Click Send.

The following example shows the HTTPS request:

Copy

curl --location 'https://ams-apigateway-cloud-ca-01.azure-api.net/authentication/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Ocp-Apim-Subscription-Key: YourApiSubscriptionKey' \
--data-urlencode 'username=your@email.com' \
--data-urlencode 'password=YourPassword'

The response provides the JWT as part of the JSON response body in the field "access_token": "YourJWT":

Copy

{
    "access_token": "YourJWT",
    "scope": "read:users",
    "expires_in": 300,
    "token_type": "Bearer"
}