API (v1) Documentation



Request


Request URL
https://apiv1.brandinsert.com/insert/[API_CODE_HERE]

How to obtain an API Key?

Any company with a BrandInsert.com account can generate and provide you an API Key.



Response


Response Format
JSON

Sample Successful Response Code
{
    "success": true,
    "api_details": {
        "api_id": "17",
        "api_name": "Brandinsert.com Integration",
        "api_description": "For integrating logos on the brands page of BrandInsert.com"
    },
    "insert_details": {
        "insert_id": "47",
        "insert_name": "Logos on BrandInsert.com Brands Page",
        "insert_description": "A collection of logos to showcase our served brands."
    },
    "company_details": {
        "company_id": "13",
        "company_name": "Brand Insert LLC",
        "company_website": "www.BrandInsert.com",
        "company_email": "",
        "company_contact": "",
        "company_phone": "",
        "company_description": "For BrandInsert.com website imagery"
    },
    "assets": [
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "241",
            "asset_name": "DesignLine",
            "asset_description": "Description",
            "asset_category": "Category",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/241\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/241\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3.us-west-2.amazonaws.com\/file.brandinsert.com\/image\/241\/241.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "105",
            "asset_name": "AG Hair",
            "asset_description": "Description",
            "asset_category": "Product",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/105\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/105\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/105\/aghair.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "104",
            "asset_name": "JohnnyB",
            "asset_description": "Description",
            "asset_category": "Product",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/104\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/104\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/104\/jb_logo2.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "88",
            "asset_name": "Cost Cutters",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/88\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/88\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/88\/costcutters_logo.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "112",
            "asset_name": "Fiesta Salons",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/112\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/112\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/112\/fiesta.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "103",
            "asset_name": "First Choice",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/103\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/103\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/103\/firstchoice.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "111",
            "asset_name": "Haircrafters",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/111\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/111\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/111\/haircrafters2.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "108",
            "asset_name": "Master Cuts",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/108\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/108\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/108\/master-cuts-logo.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "109",
            "asset_name": "Pro Cuts",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/109\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/109\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/109\/pro-logo2.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "107",
            "asset_name": "Regis Salons",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/107\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/107\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/107\/Regis-Salons-Logo2.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "102",
            "asset_name": "Roosters",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/102\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/102\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/102\/roosters.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "101",
            "asset_name": "SmartStyle Logo",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/101\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/101\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/101\/Smartstyle-Logo.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "87",
            "asset_name": "Supercuts",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/87\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/87\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/87\/supercuts_new_logo.png"
        },
        {
            "asset_type_id": "1",
            "asset_type_name": "Image",
            "asset_id": "110",
            "asset_name": "TGF Hair",
            "asset_description": "Description",
            "asset_category": "Salon",
            "asset": "https:\/\/apiv1.brandinsert.com\/asset\/110\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_http": "http:\/\/apiv1.brandinsert.com\/asset\/110\/20190922IDVlPFzDeekc4IhwVOja2qxrk",
            "asset_direct": "https:\/\/s3-us-west-2.amazonaws.com\/file.brandinsert.com\/image\/110\/tgf_logo.png"
        }
    ]
}			


Sample Unsuccessful Response Code
{
    "success": false,
    "error": "Insert has been deleted.",
    "insert_details": {
        "insert_id": "49",
        "insert_name": "Product Images",
        "insert_description": "A collection of product images."
    },
    "company_details": {
        "company_id": "13",
        "company_name": "Brand Insert LLC",
        "company_website": "www.BrandInsert.com",
        "company_email": "",
        "company_contact": "",
        "company_phone": "",
        "company_description": "For BrandInsert.com website imagery"
    }
}