API Documentation

User ¶

Supports user functions.

Signup a new user ¶

Signup a new user
POST`/influencer/user/signup`

This function will signup a new user.

Example URI

POST /influencer/user/signup

Request

HideShow

Headers

Content-Type: application/json

Body

{
  "email": "a.stetter@escmediagroup.de",
  "username": "and1",
  "password": "",
  "passwordRepeat": "",
  "language": "de-DE",
  "firstname": "",
  "lastname": "",
  "terms": 0,
  "instagram_code": "",
  "date_of_birth": "",
  "subscription": 0,
  "data": [
    {
      "field": "'hair_color'",
      "value": "'green'"
    },
    {
      "field": "'hair_length'",
      "value": "'long'"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "E-Mail adress of the User."
    },
    "username": {
      "type": "string",
      "description": "Username of the User."
    },
    "password": {
      "type": "string",
      "description": "Password of the User."
    },
    "passwordRepeat": {
      "type": "string",
      "description": "Repeated password of the User."
    },
    "language": {
      "type": "string",
      "description": "Prefered language of the User."
    },
    "firstname": {
      "type": "string",
      "description": "Fistname of the User."
    },
    "lastname": {
      "type": "string",
      "description": "Lastname of the User."
    },
    "terms": {
      "type": "number",
      "description": "Value of checkbox for terms."
    },
    "instagram_code": {
      "type": "string",
      "description": "Instagram code."
    },
    "date_of_birth": {
      "type": "string",
      "description": "Date of birth."
    },
    "subscription": {
      "type": "number",
      "description": "Value of checkbox for subscription."
    },
    "data": {
      "type": "array",
      "description": "Optional data for user."
    }
  },
  "required": [
    "email",
    "username",
    "password",
    "passwordRepeat",
    "language"
  ]
}

Response 201

HideShow

Headers

Content-Type: application/json
Location: /influencer/user/signup

Body

{
  "id": 1
}

Response 400

HideShow

Empty values

Headers

Content-Type: application/json
Location: /influencer/user/signup

Body

{
  "error": "validationError",
  "messages": {
    "username": [
      "Username cannot be blank."
    ],
    "email": [
      "E-Mail cannot be blank."
    ],
    "language": [
      "Language cannot be blank."
    ],
    "password": [
      "Password cannot be blank."
    ],
    "passwordRepeat": [
      "PasswordRepeat cannot be blank."
    ]
  }
}

Activate a user ¶

Activate a user
POST`/influencer/user/activate`

This function will activate a user.

Example URI

POST /influencer/user/activate

Request

HideShow

Headers

Content-Type: application/json

Body

{
    "token": "daa528920303855493cfe876ba8da1",
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/user/activate

Body

{
  "status": true
}

Login as user ¶

Login as user
POST`/influencer/user/login`

This function will login a user.

Example URI

POST /influencer/user/login

Request

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "and1",
  "password": "testpassword"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 1,
  "email": "a.stetter@escmediagroup.de",
  "username": "and1",
  "firstname": "Hello, world!",
  "lastname": "Hello, world!",
  "language": "de-DE",
  "access_token": "_wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948",
  "phone": "null",
  "mobile": "null",
  "picture": "null"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "User id."
    },
    "email": {
      "type": "string",
      "description": "E-Mail adress of the User."
    },
    "username": {
      "type": "string",
      "description": "Username of the User."
    },
    "firstname": {
      "type": "string",
      "description": "Fistname of the User."
    },
    "lastname": {
      "type": "string",
      "description": "Lastname of the User."
    },
    "language": {
      "type": "string",
      "description": "Prefered language of the User."
    },
    "access_token": {
      "type": "string",
      "description": "Access token for user."
    },
    "phone": {
      "type": "string",
      "description": "Phone number of the User."
    },
    "mobile": {
      "type": "string",
      "description": "Mobile number of the User."
    },
    "picture": {
      "type": "string",
      "description": "User picture."
    }
  }
}

Forgot password request ¶

Forgot password request
POST`/influencer/user/forgotpassword`

This function will send a email to the user with a token for changing the password. With this token call the action “resetpassword” to change the users password.

Example URI

POST /influencer/user/forgotpassword

Request

HideShow

Headers

Content-Type: application/json

Body

{
    "email": "a.stetter@escmediagroup.de",
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/user/forgotpassword

Body

{
  "status": true
}

Reset password for User ¶

Reset password for User
POST`/influencer/user/resetpassword`

This function will change the users password after an forgot password request.

Example URI

POST /influencer/user/resetpassword

Request

HideShow

Headers

Content-Type: application/json

Body

{
  "token": "YTFOY4n7whDOWybMq2xwXNHqxwniZVpI_1526026267",
  "password": "newpassword",
  "passwordRepeat": "newpassword"
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/user/resetpassword

Body

{
  "status": true
}

Change password for User ¶

Change password for User
POST`/influencer/user/changepassword`

This function will change the users password for a logged in user.

Example URI

POST /influencer/user/changepassword

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "password": "changepassword",
  "passwordRepeat": "changepassword"
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/user/changepassword

Body

{
  "status": true
}

Change language for User ¶

Change language for User
POST`/influencer/user/changelanguage`

This function will change the users language for a logged in user.

Example URI

POST /influencer/user/changelanguage

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
    "language": "de-DE",
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/user/changelanguage

Body

{
  "status": true
}

Get login funnel questions ¶

Get login funnel questions
GET`/influencer/user/loginfunnel`

This function will get login funnel questions.

Example URI

GET /influencer/user/loginfunnel

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
   {
       "field": "body_height",
       "question": "How tall are you?",
       "answer": [
         "number"
       ]
     },
     {
       "field": "clothing_size_bottom",
       "question": "What clothing size do you have on bottom?",
       "answer": [
         "number"
       ]
     },
     {
       "field": "clothing_size_top",
       "question": "What clothing size do you have on top?",
       "answer": [
         "number"
       ]
     }
}

Validate DM activation code ¶

Validate DM activation code
POST`/influencer/user/code`

This function will validate the code which was sent to an instagram user via DM.

Example URI

POST /influencer/user/code

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
    "code": "ABC",
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/user/code

Body

{
  "status": true,
  "message": "Verification completed."
}

Profile ¶

Show profile.

Social ¶

Get social
GET`/influencer/profile/social`

This function will get the values for social media accounts for the influencer.

Example URI

GET /influencer/profile/social

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/social

Body

{
          "website": "http://www.mywebsite.com",
          "instagram": "instagram name",
          "facebook": "facebook name",
          "twitter": "twitter name",
          "youtube": "youtube name",
          "snapchat": "snapchat name",
          "linkedin": "linkedin name",
          "xing": "xing name",
}

Set social
POST`/influencer/profile/social`

This function will set social media accounts for influencer.

Example URI

POST /influencer/profile/social

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "website": "http://www.mywebsite.com",
  "instagram": "instagram name",
  "facebook": "facebook name",
  "twitter": "twitter name",
  "youtube": "youtube name",
  "snapchat": "snapchat name",
  "linkedin": "linkedin name",
  "xing": "xing name",
  "instagram_code": "12323"
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/social

Body

{
          "status": true,
    }

Payment data ¶

Get payment data
GET`/influencer/profile/payment`

This function will get the values for payment data for influencer.

Example URI

GET /influencer/profile/payment

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/paymentdata

Body

{
  "iban": "IBAN",
  "country": "DE",
  "currency": "EUR",
  "vat_id": "DE3434343",
  "vat": 19
}

Set payment data
POST`/influencer/profile/payment`

This function will set payment data for influencer.

Example URI

POST /influencer/profile/payment

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "iban": "IBAN",
  "vat_id": "DE3434343",
  "vat": 19,
  "ip": "80.12.12.23",
  "currency": "EUR",
  "country": "DE"
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/paymentdata

Body

{
          "status": true,
    }

Get all categories ¶

Get all categories
GET`/influencer/profile/allcategories`

This function will get all possible categories.

Example URI

GET /influencer/profile/allcategories

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/allcategories

Body

{
        {
          "id": 1,
          "subcategory": null,
          "name": "Food"
        },
        {
          "id": 2,
          "subcategory": 1,
          "name": "Clean Food"
        },
        {
          "id": 3,
          "subcategory": 1,
          "name": "Low Carb"
        },
        {
          "id": 4,
          "subcategory": null,
          "name": "Lifestyle"
        },
    }

Categories ¶

Get influencer categories
GET`/influencer/profile/categories`

This function will get categories for this influencer.

Example URI

GET /influencer/profile/categories

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/categories

Body

{
  "categories": [
    1,
    2,
    3,
    4,
    5
  ]
}

Set categories
POST`/influencer/profile/categories`

This function will set categories for influencer.

Example URI

POST /influencer/profile/categories

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "categories": [
    1,
    2,
    5
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/categories

Body

{
          "status": true,
    }

Personal data ¶

Get personal data
GET`/influencer/profile/data`

This function will get personal data.

Example URI

GET /influencer/profile/data

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/personal

Body

{
  "first_name": "first_name",
  "last_name": "last_name",
  "biography": "biography",
  "username": "developer5",
  "email": "email@email.de"
}

Set personal data
PUT`/influencer/profile/data`

This function will set personal data.

Example URI

PUT /influencer/profile/data

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "first_name": "first_name",
  "last_name": "last_name",
  "biography": "biography",
  "username": "developer5",
  "email": "email@email.de",
  "picture": "https://api.yimify.com/user/profile/j0HORiNBfj_aMInJ640gFGYEE3LK9oCv.jpg"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": true
}

Get personal fields ¶

Get personal fields
GET`/influencer/profile/personalfields`

This function will get possible values for personal data fields.

Example URI

GET /influencer/profile/personalfields

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/personal

Body

{
  "hair_color": [
    "black",
    "brown",
    "fair",
    "red",
    "other"
  ],
  "hair_length": [
    "long",
    "middle",
    "short"
  ],
  "hair_extensions": [
    "boolean"
  ],
  "hair_structure": [
    "curly",
    "smooth",
    "waved"
  ],
  "beard": [
    "boolean"
  ],
  "eyelash_extension": [
    "boolean"
  ],
  "artificial_nail": [
    "boolean"
  ],
  "eye_color": [
    "blue",
    "brown",
    "green",
    "grey"
  ],
  "piercings": [
    "boolean"
  ],
  "tattoos": [
    "boolean"
  ],
  "body_height": [
    "number"
  ],
  "shoe_size": [
    "number"
  ],
  "clothing_size_top": [
    "number"
  ],
  "clothing_size_bottom": [
    "number"
  ],
  "clothing_style": [
    "casual",
    "elegant",
    "sporty",
    "rock",
    "bohemian"
  ],
  "glasses": [
    "boolean"
  ],
  "contact_lens": [
    "boolean"
  ],
  "nutrition": [
    "vegan",
    "vegetarian",
    "meat"
  ],
  "children": [
    "boolean"
  ],
  "pets": [
    "cat",
    "dog",
    "small",
    "no"
  ],
  "languages": [
    "string"
  ],
  "sports": [
    "string"
  ],
  "marital_status": [
    "single",
    "taken",
    "engaged",
    "married"
  ]
}

Get personal field ¶

Get personal field
GET`/influencer/profile/personalfield/?{gender,name}`

This function will get possible values for a single personal field.

Example URI

GET /influencer/profile/personalfield/?gender&name

URI Parameters

HideShow

gender: string (required)
Gender (male/female).
name: string (required)
Name.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/personal

Body

{
          "hair_color": [
            "black",
            "brown",
            "fair",
            "red",
            "other"
          ],
    }

Settings ¶

Get settings
GET`/influencer/profile/settings`

This function will get the settings for influencer.

Example URI

GET /influencer/profile/settings

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "newsletter": 1,
  "campaign_marketplace_email": 1,
  "campaign_marketplace_dm": 1,
  "campaign_invite_email": 1,
  "campaign_invite_dm": 1,
  "campaign_start_email": 1,
  "campaign_start_dm": 1,
  "campaign_tracking_email": 1,
  "campaign_tracking_dm": 1,
  "campaign_invoice_email": 1,
  "campaign_invoice_dm": 1,
  "messenger_email": 1,
  "messenger_dm": 1
}

Set settings
PUT`/influencer/profile/settings`

This function will set settings for influencer.

Example URI

PUT /influencer/profile/settings

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "newsletter": 1,
  "campaign_marketplace_email": 1,
  "campaign_marketplace_dm": 1,
  "campaign_invite_email": 1,
  "campaign_invite_dm": 1,
  "campaign_start_email": 1,
  "campaign_start_dm": 1,
  "campaign_tracking_email": 1,
  "campaign_tracking_dm": 1,
  "campaign_invoice_email": 1,
  "campaign_invoice_dm": 1,
  "messenger_email": 1,
  "messenger_dm": 1
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
          "status": true,
    }

Personal data ¶

Get personal data
GET`/influencer/profile/personal`

This function will get the values for personal data for influencer.

Example URI

GET /influencer/profile/personal

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/personal

Body

{
          "hair_color": "green",
          "hair_length": "long",
          "hair_extensions": true,
          "beard": true,
          "eyelash_extension": false,
          "artificial_nail": false,
          "eye_color": "blue",
          "piercings": false,
          "tatoos": false,
          "body_height": 175,
          "shoe_size": 42,
          "clothing_size_top": 48,
          "clothing_size_bottom": 102,
          "clothing_style": "causal",
          "glasses": false,
          "contact_lens": false,
          "nutrition": false,
          "children": true,
          "pets": true,
          "languages": ['de-DE','en-US'],
          "sports": "basketball, football",
          "marital_status": "none"
}

Set personal data
POST`/influencer/profile/personal`

This function will set personal data for influencer.

Example URI

POST /influencer/profile/personal

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
          "hair_color": "green",
          "hair_length": "long",
          "hair_extensions": true,
          "beard": true,
          "eyelash_extension": false,
          "artificial_nail": false,
          "eye_color": "blue",
          "piercings": false,
          "tatoos": false,
          "body_height": 175,
          "shoe_size": 42,
          "clothing_size_top": 48,
          "clothing_size_bottom": 102,
          "clothing_style": "causal",
          "glasses": false,
          "contact_lens": false,
          "nutrition": false,
          "children": true,
          "pets": true,
          "languages": ['de-DE','en-US'],
          "sports": "basketball, football",
          "marital_status": "none"
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/personal

Body

{
          "status": true,
    }

Adress data ¶

Get address data
GET`/influencer/profile/address`

This function will get the values for address data for influencer.

Example URI

GET /influencer/profile/address

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/address

Body

{
  "residence": "München",
  "street": "Josef-Felder-Straße",
  "number": "53",
  "zipcode": "81241",
  "location": "München",
  "country": "Germany"
}

Set address data
POST`/influencer/profile/address`

This function will set address data for influencer.

Example URI

POST /influencer/profile/address

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "residence": "München",
  "street": "Josef-Felder-Straße",
  "number": "53",
  "zipcode": "81241",
  "location": "München",
  "country": "Germany"
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/personal

Body

{
          "status": true,
    }

Upload user image ¶

Upload user image
POST`/influencer/profile/image`

This function will upload a user image.

Example URI

POST /influencer/profile/image

Request

HideShow

Headers

Content-Type: multipart/form-data
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachmentFile"; filename="$filename"
Content-Type: $mimetype

------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response 201

HideShow

Headers

Content-Type: application/json
Location: /influencer/profile/image

Body

{
  "picture": "/user/profile/j0HORiNBfj_aMInJ640gFGYEE3LK9oCv.jpg"
}

Delete user image
DELETE`/influencer/profile/image`

This function will delete the user image.

Example URI

DELETE /influencer/profile/image

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
          "status": true,
    }

Upload passport ¶

Upload passport
POST`/influencer/profile/uploadpassport`

This function will upload an image of the passport.

Example URI

POST /influencer/profile/uploadpassport

Request

HideShow

Headers

Content-Type: multipart/form-data
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

------WebKitFormBoundary------
Content-Disposition: form-data; name="attachmentFile"; filename="$filename"
Content-Type: $mimetype

------WebKitFormBoundary------

------WebKitFormBoundary------
Content-Disposition: form-data; name="side"

front

------WebKitFormBoundary------

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "true"
}

Campaign ¶

Allow to list and accept and deny campaigns.

Get campaigns ¶

Get campaigns
GET`/influencer/campaign/list?{status,myStatus}`

This function will show campaigns depend on status.

Example URI

GET /influencer/campaign/list?status&myStatus

URI Parameters

HideShow

status: number (optional)
Status ID.
myStatus: number (optional)
MyStatus ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/list?status={status}&myStatus={myStatus}

Body

{
        {
                "id": 1,
                "status": 1,
                "name": "My Campaign",
                "type": 2,
                "description": "This is the best campaign you'd ever seen",
                "instructions": "Please post photo on instagram",
                "channel": 2,
                "payment": 1,
                "fix_price": 20.00,
                "application": 1,
                "application_start": 1500133474,
                "application_end": 1502811874,
                "execution_start": 1504280674,
                "execution_end": 1505490274,
                "label": {
                    "type": "Paid per Post",
                    "payment": "Fix",
                    "channel": "Instagram",
                    "status": "Planning"
                },
                "tracking_urls": [
                  {
                    "id": 1,
                    "link": "https://www.instagram.com/p/BrkDGFFAq_3"
                  },
                  {
                    "id": 2,
                    "link": "https://www.instagram.com/p/BrkDGFFAq_3"
                  }
                ],
                "media": [
                    {
                      "id": 1,
                      "campaign_id": 1,
                      "name": "/campaign/1/ZlpEeG5bjA6yukj6y1tzwxETETQZTRAm.jpg",
                    }
                ],
                "can": {
                  "publish": 10,
                  "delete": 30
                }
    },
    {
            "id": 2,
            "status": 2,
            "name": "My Campaign 2",
            "type": 1,
            "description": "This is the best youtube campaign you'd ever seen",
            "instructions": "Please post photo on youtube",
            "channel": 1,
            "payment": 2,
            "fix_price": 0.00,
            "application": 1,
            "application_start": 1500133474,
            "application_end": 1502811874,
            "execution_start": 1504280674,
            "execution_end": 1505490274,
            "label": {
               "type": "Free Bee",
               "payment": "Fix",
               "channel": "Youtube",
               "status": "Published"
            },
            "tracking_urls": [
              {
                "id": 1,
                "link": "https://www.instagram.com/p/BrkDGFFAq_3"
              },
              {
                "id": 2,
                "link": "https://www.instagram.com/p/BrkDGFFAq_3"
              }
            ],
            "media": [
               {
                 "id": 2,
                 "campaign_id": 2,
                 "name": "/campaign/1/ZlpEeG5bjA6yukj6y1tzwxETETQZTRAm.jpg",
               }
            ],
            "can": {
              "storno": 40,
            }
    }
}

Get campaign status ¶

Get campaigns status
GET`/influencer/campaign/status`

This function will show campaign status.

Example URI

GET /influencer/campaign/status

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/status

Body

{
    {
        "id": 10,
        "name": "Planning",
        "class": "bg-warning"
    },
    {
        "id": 20,
        "name": "Published",
        "class": "bg-primary"
    },
    {
        "id": 30,
        "name": "Ready",
        "class": "bg-success"
    },
    {
          "id": 40,
          "name": "Active",
        "class": "bg-success"
    },
    {
        "id": 50,
        "name": "Finished",
        "class": "bg-info"
    },
    {
        "id": 60,
        "name": "Paid",
        "class": "bg-info"
    },
    {
        "id": 90,
        "name": "Deleted",
        "class": "bg-danger"
    },
    {
        "id": 91,
        "name": "Storno",
        "class": "bg-primary"
    }
}

Get my campaign status ¶

Get my campaigns status
GET`/influencer/campaign/mystatus`

This function will show my campaign status.

Example URI

GET /influencer/campaign/mystatus

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/status

Body

{
    {
        id: 1,
        name: "New",
        icon: "fa fa-paper-plane-o"
    },
    {
        id: 2,
        name: "Active",
        icon: "fa fa-check"
    },
    {
        id: 3,
        name: "Rejected",
        icon: "fa fa-close"
    },
    {
        id: 4,
        name: "Applied",
        icon: "fa fa-check-square-o"
    }
}

Get campaign details ¶

Get campaign details
GET`/influencer/campaign/detail/{id}`

This function will show campaign details.

Example URI

GET /influencer/campaign/detail/id

URI Parameters

HideShow

id: number (required)
Campaign ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "id": 3
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/detail

Body

{
    {
                        "id": 1,
                        "status": 1,
                        "name": "My Campaign",
                        "type": 2,
                        "description": "This is the best campaign you'd ever seen",
                        "instructions": "Please post photo on instagram",
                        "channel": 2,
                        "payment": 1,
                        "fix_price": 20.00,
                        "application": 1,
                        "application_start": 1500133474,
                        "application_end": 1502811874,
                        "execution_start": 1504280674,
                        "execution_end": 1505490274,
                        "label": {
                            "type": "Paid per Post",
                            "payment": "Fix",
                            "channel": "Instagram",
                            "status": "Planning"
                        },
                        "tracking_urls": [
                          {
                            "id": 1,
                            "link": "https://www.instagram.com/p/BrkDGFFAq_3"
                          },
                          {
                            "id": 2,
                            "link": "https://www.instagram.com/p/BrkDGFFAq_3"
                          }
                        ],
                        "media": [
                            {
                              "id": 1,
                              "campaign_id": 1,
                              "name": "/campaign/1/ZlpEeG5bjA6yukj6y1tzwxETETQZTRAm.jpg",
                            }
                        ]
                    }
}

Accept campaign ¶

Accept campaign
POST`/influencer/campaign/accept`

This function will accept a campaign.

Example URI

POST /influencer/campaign/accept

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "id": 1
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/accept

Body

{
    status: true
}

Apply campaign ¶

Apply campaign
POST`/influencer/campaign/apply`

This function will apply a campaign.

Example URI

POST /influencer/campaign/apply

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "id": 1
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/apply

Body

{
    status: true
}

Not Apply campaign ¶

Not Apply campaign
POST`/influencer/campaign/notapply`

This function will not apply a campaign.

Example URI

POST /influencer/campaign/notapply

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "id": 1
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    status: true
}

Reject campaign ¶

Reject campaign
POST`/influencer/campaign/reject`

This function will reject a campaign.

Example URI

POST /influencer/campaign/reject

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "id": 4
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/reject

Body

{
    status: true
}

Tracking ¶

Upload tracking urls for campaign

Allow upload tracking urls for campaign ¶

Show tracking urls for campaign
GET`/influencer/tracking?{campaignId}`

This function will show tracking urls for a campaign

Example URI

GET /influencer/tracking?campaignId

URI Parameters

HideShow

campaignId: number (required)
Campaign ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    {
         "id": 1,
         "image": "https://yimify.my-project.eu/files/campaign/campaign-6.png",
         "link": "https://www.instagram.com/p/BqstFNWn8-w/",
         "likes": null,
         "comments": null
    },
    {
         "id": 2,
         "image": "https://yimify.my-project.eu/files/campaign/campaign-6.png",
         "link": "https://www.instagram.com/p/BqstFNWn8-w/",
         "likes": null,
         "comments": null
    }
}

Upload tracking url for a campaign
POST`/influencer/tracking?`

This function will upload a campaign tracking url. Url parameter has to be base64 encoded.

Example URI

POST /influencer/tracking?

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "campaignId": "1",
  "url": "aHR0cHM6Ly93d3cuaW5zdGFncmFtLmNvbS9wL0Jxc3RGTlduOC13Lw=="
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": true
}

Delete tracking url ¶

Delete tracking url
DELETE`/influencer/tracking/delete/{id}`

This function will delete a tracking url

Example URI

DELETE /influencer/tracking/delete/id

URI Parameters

HideShow

id: number (required)
Tracking url ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": true
}

News ¶

Get news.

Get news categories ¶

Get news categories
GET`/news/categories`

This function will show the news categories.

Example URI

GET /news/categories

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /news/categories

Body

{
      {
            "id": 1,
            "name": "News",
      },
      {
            "id": 2,
            "name": "Marketing",
      },
      {
            "id": 3,
            "name": "Education",
      },
}

Get news ¶

Get news
GET`/news?{type,category}`

This function will show the news.

Example URI

GET /news?type&category

URI Parameters

HideShow

type: number (optional)
Type ID (1=Influencer, 2=Agency).
category: number (optional)
Category ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /news

Body

{
    "text": "This is the news text",
    "files": {
        "New Brochure" => "https://demourl.de/files/file.pdf"
        "New Video" => "https://www.youtube.com/"
    }
}

Notifications ¶

Get notifications.

Notification ¶

Get notifications
GET`/notification/list`

This function will show all notifications

Example URI

GET /notification/list

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    {
        "id": 1,
        "name": "campaign",
        "count": 1
      },
      {
        "id": 2,
        "name": "dashboard",
        "count": 2
      },
      {
        "id": 3,
        "name": "message",
        "count": 4
      }
}

Delete notification ¶

Delete notification
DELETE`/notification/delete/{id}`

This function will delete a notification

Example URI

DELETE /notification/delete/id

URI Parameters

HideShow

id: number (required)
Notification ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": true
}

Message ¶

Get messages.

Get campaigns ¶

Get the campaigns where messages are available
GET`/influencer/message/campaigns`

This function will show the campaigns where messages are available.

Example URI

GET /influencer/message/campaigns

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/message/campaigns

Body

{
      {
          "campaign_id": 1,
          "name": "Campaign 1",
          "new": 2,
          "last_message": 1547561364,
          "execution_start": 1504280674,
          "execution_end": 1505490274,
          "image": "/campaign/campaignImage.jpeg",
      },
      {
          "campaign_id": 2,
          "name": "Campaign 2",
          "new": 3,
          "last_message": 1547561364,
          "execution_start": 1504280674,
          "execution_end": 1505490274,
          "image": "/campaign/campaignImage.jpeg",
      },
      {
          "campaign_id": 3,
          "name": "Campaign 3",
          "new": 1,
          "last_message": 1547561364,
          "execution_start": 1504280674,
          "execution_end": 1505490274,
          "image": "/campaign/campaignImage.jpeg",
       },
}

Get messages ¶

Get messages
GET`/influencer/message/conversation/{id}`

This function will show the conversation for a specific campaign.

Example URI

GET /influencer/message/conversation/id

URI Parameters

HideShow

id: number (required)
Campaign ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/message/conversation/{id}

Body

{
    {
        "id": 1,
        "campaign_id": 1,
        "influencer_user_id": 12,
        "advertiser_id": 1,
        "sender": 1,
        "message": "test",
        "files": [],
        "is_read": 0,
        "created_at": 153343433
    },
    {
        "id": 2,
        "campaign_id": 1,
        "influencer_user_id": 12,
        "advertiser_id": 1,
        "sender": 1,
        "message": "test",
        "files": [
              "http://yimify.my-project.eu/favicon.ico"
            ],
        "is_read": 0,
        "created_at": 153343433
      }
}

Get messages with campaign information ¶

Get messages with campaign information
GET`/influencer/message/conversationcampaign/{id}`

This function will show the conversation for a specific campaign with campaign information.

Example URI

GET /influencer/message/conversationcampaign/id

URI Parameters

HideShow

id: number (required)
Campaign ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "campaign": {
    "id": 1,
    "status": 20,
    "name": "Campaign 1 # Should be shown on explore",
    "campaign_type": 2,
    "payment": 1,
    "fix_price": null,
    "application": 3,
    "application_start": 1582666531,
    "application_end": 1590442531,
    "execution_start": 1586122531,
    "execution_end": 1586986531,
    "description": "Post a picture with sports car",
    "instructions": "Go to the car centre and post pictures inside a sports car.",
    "description_header": null,
    "instructions_header": null,
    "channel": 2,
    "label": {
      "type": "Paid campaigns",
      "campaign_type": "Paid campaigns",
      "payment": "Fix",
      "channel": "Instagram",
      "status": "Published"
    },
    "type": 2,
    "tracking_urls": [],
    "my_status": null,
    "can": null,
    "media": [
      "https://api.yimify.local/files/campaign/campaignImage.jpeg"
    ]
  },
  "messages": [
    {
      "id": 43,
      "campaign_id": 1,
      "influencer_user_id": 5,
      "advertiser_id": 1,
      "sender": 2,
      "message": "We would offer you 200 EUR",
      "files": [],
      "is_read": 0,
      "created_at": 1585250531,
      "deleted_at": null
    },
    {
      "id": 44,
      "campaign_id": 1,
      "influencer_user_id": 5,
      "advertiser_id": 1,
      "sender": 1,
      "message": "Ok i will join the campaign",
      "files": [],
      "is_read": 0,
      "created_at": 1585251531,
      "deleted_at": null
    }
  ]
}

Create message ¶

Create message
POST`/influencer/message/create`

This function will create a message for a specific campaign.

Example URI

POST /influencer/message/create

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
  "id": 1,
  "message": "Yes i wil do this. Thank you."
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "status": true,
  "message": {
    "campaign_id": 1,
    "influencer_user_id": 8,
    "advertiser_id": 1,
    "sender": 1,
    "message": "test 12",
    "files": "[]",
    "created_at": 1581943701,
    "id": 370
  }
}

Read message ¶

Read message
POST`/influencer/message/read/{id}`

This function will mark a message as read.

Example URI

POST /influencer/message/read/id

URI Parameters

HideShow

id: number (required)
Message ID.

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": true
}

Upload media for message ¶

Upload media for message
POST`/influencer/message/media`

This function will upload media for a message.

Example URI

POST /influencer/message/media

Request

HideShow

Headers

Content-Type: multipart/form-data
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachmentFile"; filename="$filename"
Content-Type: $mimetype

------WebKitFormBoundary7MA4YWxkTrZu0gW--

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="id"

5
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response 201

HideShow

Headers

Content-Type: application/json
Location: /influencer/message/media

Body

{
  "status": true,
  "id": 1,
  "files": "/messages/DSD0tac8-_UY_-ZYUZ_F02tsetll0xzX.jpg"
}

Dashboard ¶

Get dashboard.

Dashboard ¶

Get campaigns for application
GET`/influencer/dashboard/campaigns`

This function will get the campaings an influencer can applicate.

Example URI

GET /influencer/dashboard/campaigns

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/stats

Body

{
         {
             "id": 4,
             "name": "Campaign 4",
             "type": 2,
             "payment": 2,
             "fix_price": null,
             "application": 1,
             "application_start": null,
             "application_end": null,
             "execution_start": 1536856901,
             "execution_end": 1539448901,
             "description": "Post a picture with green plant",
             "instructions": "Go to the plant centre and post pictures of green plants.",
             "channel": 2
           },
           {
              "id": 5,
              "name": "Campaign 5",
              "type": 2,
              "payment": 1,
              "fix_price": null,
              "application": 3,
              "application_start": null,
              "application_end": null,
              "execution_start": 1536856901,
              "execution_end": 1539448901,
              "description": "Post a picture with red plant",
              "instructions": "Go to the plant centre and post pictures of red plants.",
              "channel": 2,
              "label": {
                "type": "Paid per Post",
                "payment": "Fix",
                "channel": "Instagram"
              }
           },
}

Get types ¶

Get types
GET`/influencer/campaign/types`

This function will get campaign types.

Example URI

GET /influencer/campaign/types

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/types

Body

{
    {
        "id": 1,
        "name": "Free Bee",
    },
    {
        "id": 2,
        "name": "Paid per Post",
    }
}

Get payments ¶

Get payments
GET`/influencer/campaign/payments`

This function will get campaign payment.

Example URI

GET /influencer/campaign/payments

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/payments

Body

{
    {
        "id": 1,
        "name": "Fix",
    },
    {
        "id": 2,
        "name": "Individual",
    }
}

Get channels ¶

Get channels
GET`/influencer/campaign/channels`

This function will get campaign channels.

Example URI

GET /influencer/campaign/channels

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/campaign/channels

Body

{
    {
        "id": 1,
        "name": "Youtube",
    },
    {
        "id": 2,
        "name": "Instagram",
    },
    {
        "id": 3,
        "name": "Blog",
    }
}

Get next questions ¶

Get next questions
GET`/influencer/dashboard/getquestions/{id}`

This function will get questions.

Example URI

GET /influencer/dashboard/getquestions/id

URI Parameters

HideShow

id: number (optional)
Count of questions. Default 1

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/dashboard/getquestions

Body

{
   {
       "field": "body_height",
       "question": "How tall are you?",
       "answer": [
         "number"
       ]
     },
     {
       "field": "clothing_size_bottom",
       "question": "What clothing size do you have on bottom?",
       "answer": [
         "number"
       ]
     },
     {
       "field": "clothing_size_top",
       "question": "What clothing size do you have on top?",
       "answer": [
         "number"
       ]
     }
}

Answer question ¶

Answer question
POST`/influencer/dashboard/answerquestion`

This function will answer the question.

Example URI

POST /influencer/dashboard/answerquestion

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

{
    "field": "body_height",
    "value": "195",
}

Response 200

HideShow

Headers

Content-Type: application/json
Location: /influencer/dashboard/getquestions

Body

{
  "status": true
}

Social ¶

Get social.

Get url for authorization ¶

Get url for authorization
GET`/influencer/social/app?{type}`

This function will return the url for authorization.

Example URI

GET /influencer/social/app?type

URI Parameters

HideShow

type: string (required)
Platform name (instagram).

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
      "url": "https://api.instagram.com/oauth/authorize/?response_type=code&client_id=123&redirect_uri=",
}

Set code ¶

Set code
POST`/influencer/social/code`

This function will set code for influencer.

Example URI

POST /influencer/social/code

Request

HideShow

Headers

Content-Type: application/json

Body

{
      "portal": "instagram",
      "code": "123",
      "redirect_uri": "http://abc.com",
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
      "status": true,
}

Stats ¶

Get stats.

Stats ¶

Get stats
GET`/influencer/stats/icons`

This function will get the stats for an influencer.

Example URI

GET /influencer/stats/icons

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
         "Television & Film" : "tv",
         "Music" : "music",
         "Shopping & Retail" : "shopping-cart",
         "Coffee, Tea & Beverages" : "coffee",
         "Camera & Photography" : "camera",
         "Clothes, Shoes, Handbags & Accessory" : "shopping-bag",
         "Beer, Wine & Spirits" : "beer",
         "Sports" : "heart",
         "Electronics & Computers" : "laptop",
         "Gaming" : "gamepad",
         "Activewear" : "anchor",
         "Art & Design" : "paint-brush",
         "Travel, Tourism & Aviation" : "plane",
         "Business & Careers" : "black-tie",
         "Beauty & Cosmetics" : "venus",
         "Healthcare & Medicine" : "heart",
         "Jewellery & Watches" : "diamond",
         "Restaurants, Food & Grocery" : "spoon",
         "Toys, Children & Baby" : "child",
         "Fitness & Yoga" : "heart",
         "Wedding" : "venus-mars ",
         "Tobacco & Smoking" : "pied-piper-alt",
         "Pets" : "paw",
         "Healthy Lifestyle" : "heartbeat",
         "Luxury Goods" : "diamond",
         "Home Decor, Furniture & Garden" : "home",
         "Friends, Family & Relationships" : "users",
         "Cars & Motorbikes" : "car
    }

Stats ¶

Get stats
GET`/influencer/stats`

This function will get the stats for an influencer.

Example URI

GET /influencer/stats

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "profile_picture": "/user/social/beyonce.jpg",
  "profile_name": "beyonce",
  "full_name": "Beyoncé",
  "channels": [
    "instagram",
    "youtube"
  ],
  "followers": 116605809,
  "engagements": 2697363,
  "engagementrate": 2.3132320963529356,
  "audience": {
    "male": 0.2008002000500125,
    "female": 0.7991997999499875
  },
  "location_by_country": [
    {
      "US": 0.3024897807506503,
      "BR": 0.10033444816053512,
      "GB": 0.04830917874396135,
      "IT": 0.044593088071348944
    }
  ],
  "location_by_cities": [
    [
      {
        "id": 175905,
        "name": "New York City",
        "country": "US",
        "state": "New York",
        "percentage": 0.023039762170196952
      },
      {
        "id": 298285,
        "name": "São Paulo",
        "country": "BR",
        "percentage": 0.020066889632107024
      },
      {
        "id": 207359,
        "name": "Los Angeles",
        "country": "US",
        "state": "California",
        "percentage": 0.0189520624303233
      },
      {
        "id": 51800,
        "name": "London",
        "country": "GB",
        "percentage": 0.013749535488665924
      }
    ]
  ],
  "age_split": {
    "13-17": {
      "FEMALE": 0.16889098422576826,
      "MALE": 0.037367758365769735
    },
    "18-24": {
      "FEMALE": 0.39114244461347714,
      "MALE": 0.09683364039194592
    },
    "25-34": {
      "FEMALE": 0.18302743605456237,
      "MALE": 0.065280067529106
    },
    "35-44": {
      "FEMALE": 0.027101404100037953,
      "MALE": 0.013419172105327892
    },
    "45-64": {
      "FEMALE": 0.009847531898787884,
      "MALE": 0.007089560715216661
    }
  },
  "influencer_interests": [
    "Music",
    "Art & Design"
  ],
  "audience_interests": {
    "Friends, Family & Relationships": 0.43330223880597013,
    "Clothes, Shoes, Handbags & Accessories": 0.333955223880597,
    "Toys, Children & Baby": 0.324160447761194,
    "Restaurants, Food & Grocery": 0.3199626865671642,
    "Camera & Photography": 0.3148320895522388
  },
  "influencer_brand_affinity": {
    "Music": [
      "Coachella"
    ],
    "Art & Design": [
      "Coachella"
    ]
  },
  "hashtags": {
    "neverforgettosaythankyou": 1
  },
  "audience_languages": {
    "en": 0.6187427240977881,
    "pt": 0.09982537834691502,
    "es": 0.0640279394644936
  },
  "audience_credibility": 0.9834993773349938,
  "notable_engagements": 0.12484433374844334,
  "notable_followers_ratio": 0.03739167990206286,
  "paid_post_performance": ""
}

Payment ¶

Get payment.

Outstanding Payment ¶

Outstanding payment
GET`/influencer/payment/outstanding`

This function will show all outstanding payments

Example URI

GET /influencer/payment/outstanding

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "campaign_id": 9,
  "advertiser_id": 1,
  "amount_net": "200.00",
  "vat": "19.00",
  "amount_vat": 38,
  "amount_gross": 238,
  "invoice": null,
  "paid": null,
  "campaign_name": "HOLGA 120N Instant Camera"
}

Completed Payment ¶

Completed payment
GET`/influencer/payment/completed`

This function will show all completed payments

Example URI

GET /influencer/payment/completed

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "campaign_id": 10,
  "advertiser_id": 1,
  "amount_net": "250.00",
  "vat": "19.00",
  "amount_vat": 47.5,
  "amount_gross": 297.5,
  "invoice": "/invoice/demo.pdf",
  "paid": 1,
  "campaign_name": "HOLGA 120N Instant Camera - PAID"
}

Upload invoice ¶

Upload invoice
POST`/influencer/payment/invoice`

This function will upload invoice.

Example URI

POST /influencer/payment/invoice

Request

HideShow

Headers

Content-Type: multipart/form-data
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Body

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachmentFile"; filename="$filename"
Content-Type: $mimetype

------WebKitFormBoundary7MA4YWxkTrZu0gW--

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="id"

5
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response 201

HideShow

Headers

Content-Type: application/json
Location: /influencer/payment/invoice

Body

{
  "status": true,
  "files": "/invoice/5/DSDUZ2tsetxX.pdf"
}

Tooltip ¶

Show tooltip.

Get tooltips ¶

Get tooltips
GET`/influencer/tooltip/show`

This function will show the tooltips.

Example URI

GET /influencer/tooltip/show

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer _wAEdVfIX9GcEa2WoHQHFPq1NzBY2TIT_1525969948

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    "dashboard_status": "In dieser Übersicht können alle Kampagnen nach ihrem jeweiligen Status sortiert werden.\r\n",
    "campaign_create": "Das Akzeptieren der Abbuchung von € 80,- (nicht zusätzlich - wird verrechnet) ermöglicht die Suche in unserer Influencer-Datenbank. \r\n",
    "campaign_name": "Hier bitte den Titel der Kampagne festlegen.\r\n",
}

User ¶

Signup a new user ¶

Signup a new userPOST/influencer/user/signup

Example URI

Headers

Body

Schema

Headers

Body

Headers

Body

Activate a user ¶

Activate a userPOST/influencer/user/activate

Example URI

Headers

Body

Headers

Body

Login as user ¶

Login as userPOST/influencer/user/login

Example URI

Headers

Body

Headers

Body

Schema

Forgot password request ¶

Forgot password requestPOST/influencer/user/forgotpassword

Example URI

Headers

Body

Headers

Body

Reset password for User ¶

Reset password for UserPOST/influencer/user/resetpassword

Example URI

Headers

Body

Headers

Body

Change password for User ¶

Change password for UserPOST/influencer/user/changepassword

Example URI

Headers

Body

Headers

Body

Change language for User ¶

Change language for UserPOST/influencer/user/changelanguage

Example URI

Headers

Body

Headers

Body

Get login funnel questions ¶

Get login funnel questionsGET/influencer/user/loginfunnel

Example URI

Headers

Headers

Body

Validate DM activation code ¶

Validate DM activation codePOST/influencer/user/code

Example URI

Headers

Body

Headers

Body

Profile ¶

Social ¶

Get socialGET/influencer/profile/social

Example URI

Headers

Headers

Body

Set socialPOST/influencer/profile/social

Example URI

Headers

Body

Headers

Body

Signup a new user
POST`/influencer/user/signup`

Activate a user
POST`/influencer/user/activate`

Login as user
POST`/influencer/user/login`

Forgot password request
POST`/influencer/user/forgotpassword`

Reset password for User
POST`/influencer/user/resetpassword`

Change password for User
POST`/influencer/user/changepassword`

Change language for User
POST`/influencer/user/changelanguage`

Get login funnel questions
GET`/influencer/user/loginfunnel`

Validate DM activation code
POST`/influencer/user/code`

Get social
GET`/influencer/profile/social`

Set social
POST`/influencer/profile/social`

Get payment data
GET`/influencer/profile/payment`

Set payment data
POST`/influencer/profile/payment`

Get all categories
GET`/influencer/profile/allcategories`

Get influencer categories
GET`/influencer/profile/categories`

Set categories
POST`/influencer/profile/categories`

Get personal data
GET`/influencer/profile/data`

Set personal data
PUT`/influencer/profile/data`

Get personal fields
GET`/influencer/profile/personalfields`

Get personal field
GET`/influencer/profile/personalfield/?{gender,name}`

Get settings
GET`/influencer/profile/settings`

Set settings
PUT`/influencer/profile/settings`

Get personal data
GET`/influencer/profile/personal`