gyfti doc API
  • General documentation of gyfti
  • Authentification
  • Automate your gifts
    • Retrieve your gyfti campaigns
    • Add contact to campaign
  • Retrieve data from campaigns
    • New order
    • New email
    • Order update
  • Using gyfti Store
    • Add or update a user in your store
    • Add a new pool to your users
    • Retrieve new orders and pool update
Powered by GitBook
On this page
  • Login api call
  • Verify credentials with token
  • Retrieve user's campaign trigger
  • Retrieve user's campaign trigger (postal)
  • Add new contact to a trigger campaign (email)
  • Add new contact to a trigger campaign (postal)

General documentation of gyfti

Login api call

POST https://app.gyfti.fr/api/1.1/wf/login/

This call allows you to login on the platform

Request Body

Name
Type
Description

email*

string

user's email login address for his gyfti account

password*

string

user's password

{
    "status": "success",
    "response": {
        "token": "[YOUR_TOKEN]",
        "user_id": "[YOUR_USER_ID]",
        "expires": 
    }
}
{
    // Response
}
{
    "email" : "user@email.com",
    "password" : "userspassword"
}

Verify credentials with token

POST https://app.gyfti.fr/api/1.1/wf/is_log

Headers

Name
Type
Description

Authorization*

string

'Bearer [YOUR_TOKEN]'

{
    "status": "success",
    "response": {
        "user": {
            "Created Date": 1632500327533,
            "Modified Date": 1654592353339,
            "user_signed_up": true,
            "authentication": {
                "email": {
                    "email": "users@email.com",
                    "email_confirmed": true
                }
            },
            "FirstName": "User First Name",
            "LastName": "User Last Name",
            "Company": "Company ID",
            "FullName": " ",
            "Picture": "Profile picture",
            "Signature": "Your signature",
            "Favorite products": [
                "Product ID",
                "Product ID"
            ],
            "Confirm-email": true,
            "news-update": true,
            "Role": "Admin",
            "Status": "Actif",
            "onboarding": true,
            "Team": "1653036584766x296414308790698000",
            "_id": "1632500327487x574792221359071300"
        },
        "state": "The user is logged in"
    }
}

Retrieve user's campaign trigger

GET https://app.gyfti.fr/api/1.1/obj/Campaign

Headers

Name
Type
Description

Authorization*

string

'Bearer [YOUR_TOKEN]'

{
    "response": {
        "cursor": 0,
        "results": [
            {
                "Campaign_Name": "",
                "Campaign Reason": "",
                "Start date": "",
                "Tag": [],
                "Created By": "",
                "Created Date": "",
                "Modified Date": "",
                "Campaign Type": "",
                "_id": ""
            },
}

Retrieve user's campaign trigger (postal)

GET https://app.gyfti.fr/api/1.1/obj/Campaign

Headers

Name
Type
Description

Authorization*

String

'Bearer [YOUR_TOKEN]'

[
  {
    "Campaign Status": "Published",
    "Created Date": "2022-11-09T14:54:54.973Z",
    "Created By": "1632500327487x574792221359071300",
    "Modified Date": "2023-02-07T19:09:27.314Z",
    "Campaign_Name": "test campagne Zapier",
    "Campaign Reason": "Début de contrat",
    "Contacts": [
      "1632758122730x597040260919066600"
    ],
    "Products": [
      "1635951543416x839792715571966700"
    ],
    "Company owner": "1634657344041x544157150139120900",
    "Cost": 20.5,
    "Owner": "1632500327487x574792221359071300",
    "english": false,
    "Email-company": false,
    "Campaign Type": "Directe trigger",
    "Campaign Active Status": "Active",
    "Payment Method ID": "card_1L8NOrBYenjykI90G88Flhfb",
    "Etat de facturation": "En attente",
    "Donations Allowed": true,
    "id": "1668005694737x814513677559398400"
  },
  {
    "Campaign Status": "Published",
    "Created Date": "2023-01-18T18:29:49.646Z",
    "Created By": "1632500327487x574792221359071300",
    "Modified Date": "2023-01-18T18:33:44.832Z",
    "Campaign_Name": "test trigger avant MEP",
    "Campaign Reason": "Fidélisation",
    "Contacts": [
      "1669814854853x372123130763149300",
      "1674064068360x106670271629885440"
    ],
    "Email message": "",
    "Products": [
      "1635951551681x278283392916034440"
    ],
    "Company owner": "1634657344041x544157150139120900",
    "Cost": 84.08,
    "Owner": "1632500327487x574792221359071300",
    "english": false,
    "Email-company": false,
    "Campaign Type": "Directe trigger",
    "Campaign Active Status": "Active",
    "Payment Method ID": "Virement",
    "Etat de facturation": "En attente",
    "CGV_Accepted": true,
    "Donations Allowed": true,
    "id": "1674066589330x346680148415217660"
  }
]

Add new contact to a trigger campaign (email)

POST https://app.gyfti.fr/api/1.1/wf/1_zapier_add_contact_trigger/

Request Body

Name
Type
Description

contact_firstname*

String

Your recipent first name

contact_lastname*

String

Your recipient last name

contact_email*

String

Your recipient email adress

campaign*

String

The gyfti campaign from your account you wish to send to the recipient

jobtitle

String

Your recipient jobtitile

Phone

String

Your recipient jobtitle

Additional_address

String

Your recipient additional address

Address

String

Your recipient address (number and street)

City

String

Your recipient's city

Postal_code

String

Your recipient's postal code

Country

String

Your recipient's country

{
  "status": "success",
  "response": {}
}
{
  "inputData": {
    "campaign": "",
    "contact_email": "",
    "contact_firstname": "",
    "contact_lastname": "",
    "jobtitle": "",
    "Phone": "",
    "Adress": "",
    "Additional_address": "",
    "Postal_code": "",
    "City": "",
    "Country": ""
  },
}

Add new contact to a trigger campaign (postal)

POST https://app.gyfti.fr/api/1.1/wf/1_zapier_add_contact_trigger_directe/

Request Body

Name
Type
Description

contact_email*

String

Your recipient email address

contact_fistname*

String

Your recipient first name

country*

String

Your recipient's country (for delivery purposes)

city*

String

Your recipient's city (for delivery purposes)

postal_code*

String

Your recipient's postal code (for delivery purposes)

additional_address

String

Your recipient's additional address (for delivery purposes)

address*

String

Your recipient's address (number and street name) for delivery purposes

phone*

String

Your recipient phone number (for delivery purposes)

jobtitle

String

Your recipient jobtitle

campaign*

String

The gyfti campaign (postal) from your account you wish to send to the recipient

contact_lastname*

String

Your recipient last name

{
  "status": "success",
  "response": {}
}

NextAuthentification

Last updated 1 year ago