Sessions

Cloud Mock

https://mock.apidog.com/m1/479670-0-default

POST

/v1/sessions

Create a session for the provided site. If the site does not exist in Flip's system, it will be commissioned, otherwise it will be reused.
If a site already exists, it is possible to only provide site.id in the body, otherwise the schema is as described below.

Session tokens can only be used once.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

site

object

required

string

required

The ID of the site in your system.

Example:

abc-789

first_name

string | null

optional

Example:

John

last_name

string | null

optional

Example:

Doe

company_name

string | null

optional

Ony if the customer is a company

Example:

ABC Co.

string <email> | null

optional

state_code

enum<string> | enum<null>

State code

optional

Two-character code representing a US state or territory.

Allowed values:

AKALARAZCACOCTDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUTVAVTWAWIWVWY

city

string | null

City

optional

Example:

San Francisco

zip_code

string | null

Zip Code

optional

In the sandbox, use zip codes 88800, 88801 or 88802 to match with test programs.

Examples:

888008880188802

street_address

string | null

Street Address

optional

Example:

123 Main St

street_address2

string | null

Street Address2

optional

devices

array [object {7}]

required

string

required

Example:

xyz-123

manufacturer_name

string

Manufacturer Name

required

Example:

DeviceMaker

product_name

string

Product Name

required

Example:

Model 1

serial_number

string

Serial Number

required

Example:

123456789

type

enum<string>

required

Allowed values:

BATTERYEV_CHARGER

attributes

object (DeviceBatteryAttributes)

required

Structure depends on type. They are not user-adjustable and should be configured during installation / commissioning.

install_date

string <date-time>

required

The date the device was installed at the customer's site, or the date it received permission to operate from the utility, if different.

Example:

2025-06-19T15:30:00-07:00

Example

{
    "site": {
        "id": "abc-789",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "ABC Co.",
        "email": "[email protected]",
        "state_code": "AK",
        "city": "San Francisco",
        "zip_code": "88800",
        "street_address": "123 Main St",
        "street_address2": "string"
    },
    "devices": [
        {
            "id": "xyz-123",
            "manufacturer_name": "DeviceMaker",
            "product_name": "Model 1",
            "serial_number": "123456789",
            "type": "BATTERY",
            "attributes": {
                "battery_capacity_wh": 15000,
                "battery_power_input_w": 6000,
                "battery_power_output_w": 7500
            },
            "install_date": "2025-06-19T15:30:00-07:00"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/479670-0-default/v1/sessions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "site": {
        "id": "abc-789",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "ABC Co.",
        "email": "[email protected]",
        "state_code": "AK",
        "city": "San Francisco",
        "zip_code": "88800",
        "street_address": "123 Main St",
        "street_address2": "string"
    },
    "devices": [
        {
            "id": "xyz-123",
            "manufacturer_name": "DeviceMaker",
            "product_name": "Model 1",
            "serial_number": "123456789",
            "type": "BATTERY",
            "attributes": {
                "battery_capacity_wh": 15000,
                "battery_power_input_w": 6000,
                "battery_power_output_w": 7500
            },
            "install_date": "2025-06-19T15:30:00-07:00"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

token

string

required

Example:

xyz-abc

has_programs

boolean | null

required

A boolean indicating whether the site is eligible to participate in at least one available program. Returns true if one or more programs are available for the site; otherwise, false.

Example

{
    "token": "xyz-abc",
    "has_programs": true
}

🟠400Invalid input

Modified at 2025-06-12 14:18:18

Commission Site And Devices

Command Created