API Platform Guide

https://docs.sensedia.com
Admin
This project provides a comprehensive guide and documentation for an API platform, covering various...
Tokens:38,693
Snippets:718
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### WhatsApp Activation Message Example

Source: https://docs.sensedia.com/docs/flexible-actions/flexible-actions-integrations-flex/flexible-actions-phone-catalog

This is an example of the activation message a contact will receive on WhatsApp to confirm registration for Flexible Actions notifications. It outlines how to confirm or refuse and how to opt-out.

```jsx
1
Hello, contact name!
2


3
Your number has been linked to a Sensedia Flexible Actions notification channel.
4
This is an automatic message to confirm the registration on the platform.
5
By confirming, you will accept to receive notifications of events registered on the platform linked to this number.
6


7
Type:
8
YES to confirm
9
NO to refuse
10


11
You can also stop receiving notifications at any time by sending CANCEL to this number.

```

--------------------------------

### Basic Authentication Header Example

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

All webhook endpoints use basic authentication. This example shows the format of the Authorization header required.

```http
Authorization: Basic <username:password base64>
```

--------------------------------

### AWS Lambda Example for Creating API Key

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

Python example for an AWS Lambda function that creates an API Key and associates it with specified Usage Plans. This code is a reference and should be adapted to specific security needs.

```python
def create_api_key(request_body):
    """Creates a new API Key and associates it with the requested Usage Plans. Return the API Key ID and value."""
    client = boto3.client("apigateway")


    app_slug = request_body.get("appSlug")
    developer = request_body.get("developer")
    apis = request_body.get("apis", [])


    try:
        api_key_response = client.create_api_key(
            name=create_credential_name(app_slug, developer),
            enabled=True,
            # tags={'string':'string'} can be used to distinct API Key created by the webhook
        )


        api_key_id = api_key_response["id"]
        api_key_value = api_key_response["value"]


        # Iterate over APIs in the request body
        for api_data in apis:
            # api_id = api_data.get('id') can be used to verify if API is still related to the Usage Plan
            usage_plans = api_data.get("usagePlans", [])


            # Iterate over usage plans for each API
            for usage_plan in usage_plans:
                usage_plan_id = usage_plan.get("id")


                # Associate API Key with Usage Plan
                client.create_usage_plan_key(
                    usagePlanId=usage_plan_id, keyId=api_key_id, keyType="API_KEY"
                )


        return {
            "statusCode": 200,
            "body": json.dumps(
                {
                    "credentialType": "API_KEY",
                    "apiKeyId": api_key_id,
                    "apiKey": api_key_value,
                    "customCredentials": {
                        "qaautomation-token-1": "qaautomationtoken1",
                        "qaautomation-token-2": "qaautomationtoken2",
                        "qaautomation-token-3": "qaautomationtoken3",
                        "qaautomation-token-4": "qaautomationtoken4",
                        "qaautomation-token-5": "qaautomationtoken5"
                    },


                }
            ),
        }
    except Exception as e:
        logger.error("create_api_key error: %s", str(e))
        return handle_error(str(e))
```

--------------------------------

### AWS API Gateway GET Policy (Wildcard Resource)

Source: https://docs.sensedia.com/docs/catalogs/catalogs-aws-connection

This policy grants read-only access to all API Gateway resources. Use this for broad access requirements.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "apigateway:GET"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}
```

--------------------------------

### AWS API Gateway GET Policy (Specific Resources)

Source: https://docs.sensedia.com/docs/catalogs/catalogs-aws-connection

This policy grants read-only access to specific API Gateway resources, including REST APIs, deployments, and usage plans. It is more restrictive than the wildcard policy.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "apigateway:GET"
            ],
            "Resource": [
                "arn:aws:apigateway:*::/restapis",
                "arn:aws:apigateway:*::/restapis/*",
                "arn:aws:apigateway:*::/restapis/*/stages",
                "arn:aws:apigateway:*::/restapis/*/deployments",
                "arn:aws:apigateway:*::/restapis/*/deployments/*",
                "arn:aws:apigateway:*::/apis",
                "arn:aws:apigateway:*::/apis/*",
                "arn:aws:apigateway:*::/apikeys",
                "arn:aws:apigateway:*::/usageplans"
            ]
        }
    ]
}
```

--------------------------------

### Accessing Platform with Tenant Alias

Source: https://docs.sensedia.com/docs/access-control/access-control-start/access-control-login

Use this URL format to access the platform by directly including your tenant alias. Replace '<tenant*alias>' with your actual tenant alias.

```jsx
http://<tenant*alias>.signin.platform-ephemeral.sensedia-eng.com
```

--------------------------------

### Check Availability Endpoint

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

Use this HTTP GET endpoint to check the application's health. A successful response is indicated by a 204 No Content status code.

```http
GET /v1/health
```

--------------------------------

### Apply Policy Enforcement Configuration via Sensedia CLI

Source: https://docs.sensedia.com/docs/adaptive-governance/adaptive-governance-lifecycle/adaptive-governance-policy-enforcement

Use this command to apply the downloaded YAML configuration file for policy enforcement. Ensure you replace '[file-name]' with the actual name of your configuration file.

```bash
ssd apply -f [file-name].yaml
```

--------------------------------

### Create Credentials

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

Endpoint responsible for creating and returning app credentials. It requires basic authentication and accepts app details in the request body. The response provides either API Key or Client Credentials.

```APIDOC
## POST /v1/createCredentials

### Description
Endpoint responsible for creating and returning the app credentials.

### Method
POST

### Endpoint
/v1/createCredentials

### Parameters
#### Header
- **Authorization** (string) - Required - Basic <username:password base64>

#### Request Body
- **appName** (string) - Required - The name of the application.
- **developer** (string) - Required - The developer's identifier.
- **apis** (array) - Required - A list of APIs the app will have access to.
  - **id** (string) - Required - The API ID.
  - **usagePlans** (array) - Required - A list of usage plans for the API.
    - **id** (string) - Required - The usage plan ID.

### Response
#### Success Response (200 OK)
- **credentialType** (string) - Required - The type of credential returned ('CLIENT_CREDENTIALS' or 'API_KEY').
- **clientId** (string) - Optional - The client ID, returned if credentialType is 'CLIENT_CREDENTIALS'.
- **clientSecret** (string) - Optional - The client secret, returned if credentialType is 'CLIENT_CREDENTIALS'.
- **apiKeyId** (string) - Optional - The API key ID, returned if credentialType is 'API_KEY'.
- **apiKey** (string) - Optional - The API key, returned if credentialType is 'API_KEY'.
- **customCredentials** (object) - Optional - Additional custom credentials.

#### Response Example
```json
{
  "credentialType": "CLIENT_CREDENTIALS",
  "clientId": "your_client_id",
  "clientSecret": "your_client_secret"
}
```
```json
{
  "credentialType": "API_KEY",
  "apiKeyId": "your_api_key_id",
  "apiKey": "your_api_key"
}
```
```

--------------------------------

### Create Credentials Endpoint

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

This endpoint is responsible for creating and returning app credentials. It requires basic authentication and accepts an app name, developer details, and associated APIs in the request body.

```http
POST /v1/createCredentials
```

--------------------------------

### Create Cognito App Client

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

Creates a Cognito app client with specified configurations for generating client credentials. This function requires the AWS SDK (boto3) and a pre-defined USER_POOL_ID and OAUTH_CUSTOM_SCOPES.

```python
def create_cognito_app_client(request_body):
    """Creates a Cognito app client and returns the client id and client secret."""
    cognito_client = boto3.client("cognito-idp")
    app_slug = request_body.get("appSlug")
    developer = request_body.get("developer")


    try:
        response = cognito_client.create_user_pool_client(
            UserPoolId=USER_POOL_ID,
            ClientName=create_credential_name(app_slug, developer),
            GenerateSecret=True,
            AllowedOAuthFlowsUserPoolClient=True,
            AllowedOAuthScopes=OAUTH_CUSTOM_SCOPES,
            AllowedOAuthFlows=["client_credentials"],
            SupportedIdentityProviders=["COGNITO"],
        )


        app_client_id = response["UserPoolClient"]["ClientId"]
        app_client_secret = response["UserPoolClient"]["ClientSecret"]


        return {
            "statusCode": 200,
            "body": json.dumps(
                {
                    "credentialType": "CLIENT_CREDENTIALS",
                    "clientId": app_client_id,
                    "clientSecret": app_client_secret,
                }
            ),
        }
    except Exception as e:
        logger.error("create_user_pool_client error: %s", str(e))
        return handle_error(str(e))
```

--------------------------------

### Create Credentials Request Body

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

The request body for creating credentials includes the application name, developer identifier, and a list of APIs with their usage plans.

```json
{
 "appName": "string",
 "developer": "string",
 "apis": [
   {
     "id": "string",
     "usagePlans": [
       {
         "id": "string"
       }
     ]
   }
 ]
}
```

--------------------------------

### Create Credentials Response Body

Source: https://docs.sensedia.com/docs/developer-portal/developer-portal-overview/developer-portal-apps/developer-portal-webhook

The response body for creating credentials can return either CLIENT_CREDENTIALS (with clientId and clientSecret) or API_KEY (with apiKeyId and apiKey). The customCredentials field can be used to return additional information.

```json
{
 "credentialType": "CLIENT_CREDENTIALS | API_KEY",
 "clientId": string,
 "clientSecret": string,
 "apiKeyId": string,
 "apiKey": string
}
```
Tokens:
Raw