Skip to main content

Frequency Documentation

Authentication

Hostname

      
https://prd-freq.frequency.com/api/2.1

Auth Login

Endpoint
POST /auth/login

Request

Headers

"Content-Type": "application/json"

Payload

{
"account_name": "Company Name",    
"email": "api_user@company.com",    
"password": "ff38a3d!57f@cd2d"
}

Response

Body

{    
"country": "US",    
"user_agent": "5234523453463",    
"device_id": "d9d7465c2341014f26a87629be46639e",    
"token": {        
    "token_access": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2",        
    "token_refresh": "5118b5a4-022cfdb-aa8e4a86c33-0f3d0",        
        "roles": [            
            "ROLE_USER",            
            "ROLE_ADMIN"        
        ]    
    }
}

Auth Device

Endpoint
POST /auth/device

Request

Headers

"Content-Type": "application/json"

Payload

{
"app_name": "Default",    
"sdk_key": "f26dd61135eba4687629be4dd61135eba29be46"
}

Response

Body

{    
"country": "US",    
"user_agent": "5234523453463",    
"device_id": "d9d7465c2341014f26a87629be46639e",    
"token": {        
    "token_access": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2",        
    "token_refresh": "5118b5a4-022cfdb-aa8e4a86c33-0f3d0",        
        "roles": [            
           "ROLE_ANONYMOUS"         
        ]     
    }
}

Auth Refresh

Endpoint

Refresh Expired API Credentials

POST /auth/refresh

Request

Headers

"Content-Type": "application/json"

Payload

{    
"token_refresh": "5118b5a4-022cfdb-aa8e4a86c33-0f3d0"
}

Response

Body

{    
"country": "US",    
"user_agent": "5234523453463",    
"device_id": "d9d7465c2341014f26a87629be46639e",    
"token": {        
    "token_access": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2",        
    "token_refresh": "5118b5a4-022cfdb-aa8e4a86c33-0f3d0",        
        "roles": [            
            "ROLE_USER",            
            "ROLE_ADMIN"        
        ]    
    }
}
In this section: