API Guide

General Usage

13min

Enefits API
The Enefits API gives developers access to many of the features that drive the Enefits Exchange that connects brands to the web3 world - and vice versa.
If you're interested in integrating the SDK in your app for verification of ownership of NFTs and confirming Enefits Offer eligibility, head to this documentation to learn more.
To obtain an API Key, simply register at http://enefits.co, go to Developer in the account menu in the top right section.  From there, generate an API Key and save this for all API requests as defined below.  We only show this once so if you lose this API Key, you’ll have to re-generate from the Developer section.
In this documentation we refer to the API Key as {api_key}
The base url for all requests is https://api.enefits.co/developer/v1/﻿
If you have any trouble getting started with this API or need general help, e-mail [email protected].
/offers.json (GET)
Retrieve active offers from Enefits Offer Network for a given NFT collection by smart contract address.
Usage: https://api.enefits.co/developer/v1/offers.json?api_key={api_key}&contract_address={contract_address}﻿
Request Parameters
Parameter
Description
Required
api_key
Your API Key
Yes
contract_address
The smart contract address of the collection you would like to retrieve offers for
Yes
token_id
A specific token ID in the collection represented by the contract_address
No
chain
Options: ETH, SOL, MATIC
If this is not provided, the API aims to use contract_address alone to determine chain
No
network
Options: mainnet, testnet 
If this is not provided, the API determines the chain network based on supplied contract_address
No
﻿
Response
JSON
{
   "status":"success",
   "message":null,
   "data":{
      "offers":[
         {
            "_id":"620b1c827cc1181c540db432",
            "name":"My Test Offer",
            "description":"A test offer for the world.",
            "promo_description":"The best Offer for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"my-test-offer",
            "collection_ids":[
               
            ],
            "user_id":"620b1c4a00fe583edd22e0c2",
            "updated_at":"2022-03-04 11:52:33",
            "created_at":"2022-02-15 03:22:42",
            "meta_collection_ids":[
               "620a5e1cc969ce0da9575eb1",
               "620a6227c969ce0da9580a8f"
            ]
         },
         {
            "_id":"620b5006b1a45a308126bb22",
            "name":"TicketHub Priority Access",
            "description":"Priority Lane Access for NFT Holders",
            "promo_description":"Priority Lane Access for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"tickethub-priority-access",
            "collection_ids":[
               
            ],
            "user_id":"620b4fd5087bb5370f220072",
            "updated_at":"2022-02-15 07:02:30",
            "created_at":"2022-02-15 07:02:30"
         }
      ]
   }
}
{
   "status":"success",
   "message":null,
   "data":{
      "offers":[
         {
            "_id":"620b1c827cc1181c540db432",
            "name":"My Test Offer",
            "description":"A test offer for the world.",
            "promo_description":"The best Offer for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"my-test-offer",
            "collection_ids":[
               
            ],
            "user_id":"620b1c4a00fe583edd22e0c2",
            "updated_at":"2022-03-04 11:52:33",
            "created_at":"2022-02-15 03:22:42",
            "meta_collection_ids":[
               "620a5e1cc969ce0da9575eb1",
               "620a6227c969ce0da9580a8f"
            ]
         },
         {
            "_id":"620b5006b1a45a308126bb22",
            "name":"TicketHub Priority Access",
            "description":"Priority Lane Access for NFT Holders",
            "promo_description":"Priority Lane Access for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"tickethub-priority-access",
            "collection_ids":[
               
            ],
            "user_id":"620b4fd5087bb5370f220072",
            "updated_at":"2022-02-15 07:02:30",
            "created_at":"2022-02-15 07:02:30"
         }
      ]
   }
}
﻿
/address/{owner_address}/offers.json (GET)
Retrieve active offers from Enefits Offer Network for a given owner address.
Usage: https://api.enefits.co/developer/v1/address/{owner_address}/offers.json?api_key={api_key}﻿
Request Parameters
Parameter
Description
Required
api_key
Your API Key
Yes
owner_address
The owner address  to retrieve offers for
Yes
scope
Options: account, global (requires special api_key permissions; contact: [email protected])

account: Returns offers for account that owns api_key 
global: Returns all offers that owner_address is eligible for
No
chain
Options: ETH, SOL, MATIC
No
Response
JSON
{
   "status":"success",
   "message":null,
   "data":{
      "offers":[
         {
            "_id":"620b1c827cc1181c540db432",
            "name":"My Test Offer",
            "description":"A test offer for the world.",
            "promo_description":"The best Offer for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"my-test-offer",
            "collection_ids":[
               
            ],
            "user_id":"620b1c4a00fe583edd22e0c2",
            "updated_at":"2022-03-04 11:52:33",
            "created_at":"2022-02-15 03:22:42",
            "meta_collection_ids":[
               "620a5e1cc969ce0da9575eb1",
               "620a6227c969ce0da9580a8f"
            ]
         },
         {
            "_id":"620b5006b1a45a308126bb22",
            "name":"TicketHub Priority Access",
            "description":"Priority Lane Access for NFT Holders",
            "promo_description":"Priority Lane Access for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"tickethub-priority-access",
            "collection_ids":[
               
            ],
            "user_id":"620b4fd5087bb5370f220072",
            "updated_at":"2022-02-15 07:02:30",
            "created_at":"2022-02-15 07:02:30"
         }
      ]
   }
}
{
   "status":"success",
   "message":null,
   "data":{
      "offers":[
         {
            "_id":"620b1c827cc1181c540db432",
            "name":"My Test Offer",
            "description":"A test offer for the world.",
            "promo_description":"The best Offer for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"my-test-offer",
            "collection_ids":[
               
            ],
            "user_id":"620b1c4a00fe583edd22e0c2",
            "updated_at":"2022-03-04 11:52:33",
            "created_at":"2022-02-15 03:22:42",
            "meta_collection_ids":[
               "620a5e1cc969ce0da9575eb1",
               "620a6227c969ce0da9580a8f"
            ]
         },
         {
            "_id":"620b5006b1a45a308126bb22",
            "name":"TicketHub Priority Access",
            "description":"Priority Lane Access for NFT Holders",
            "promo_description":"Priority Lane Access for NFT Holders",
            "type":"access",
            "expires_at":null,
            "slug":"tickethub-priority-access",
            "collection_ids":[
               
            ],
            "user_id":"620b4fd5087bb5370f220072",
            "updated_at":"2022-02-15 07:02:30",
            "created_at":"2022-02-15 07:02:30"
         }
      ]
   }
}
﻿
/express-mint.json (POST)
Mint a new NFT on the Polygon blockchain.
Usage: https://api.enefits.co/developer/v1/express-mint.json?api_key={api_key}﻿
Request Parameters
Parameter
Description
Required
api_key
Your API Key
Yes
name
Name of the Collection/NFT
Yes
description
Short description of the NFT
Yes
asset_url
URL of the digital asset (image, audio, video etc) that is the NFT's creative 
Yes
symbol
A unique symbol to identify the NFT (maximum of 8 characters)
Yes
website
Website for the NFT
No
network
Network to use; valid are testnet (default) and `mainnet`
No
transfer_address
Account address to which NFT will be tranferred after being minted (either a crypto address or an e-mail address)
No
Response
On successful minting, the API returns with HTTP status code `200`
When any of the mandatory input fields are missing, the API fails with HTTP status code `422 - Unprocessable content`
When minting fails due to insufficient MATIC balance, the API fails with custom HTTP status code `420`
Success
Invalid Input
Insufficient Balance
{
    "message": "Not enough balance to cover transaction charges. Please refill your wallet.",
    "data": {},
    "errors": {
        "estimate": 0.4059999999999999,
        "balance": 0,
    }
}
{
    "message": "Not enough balance to cover transaction charges. Please refill your wallet.",
    "data": {},
    "errors": {
        "estimate": 0.4059999999999999,
        "balance": 0,
    }
}
﻿
﻿
/nftemplate/claim.json (POST)
Create an NFT from an NFTemplate
Usage: https://api.enefits.co/developer/v1/nftemplate/claim.json?api_key={api_key}﻿
Request Parameters
Parameter
Description
Required
api_key
Your API Key
Yes
nftemplate_id
The nftemplate_id of the NFTemplate. To get the nftemplate_id click on the NFTemplate card from the NFT collection the NFTemplate is listed under to visit the NFTemplate Details screen and copy/paste from there  
Yes
address
Wallet address to send NFT to after minting
Yes, if no email param is provided
email
Email address to send NFT to after minting
Yes, if no address  param is provided
flow
Options: claim, direct

claim: User must claim via claim page
direct: Automatically delivers NFT to user via email; requires email param to be present
No (defaults to claim)

Response
On successful minting, the API returns with HTTP status code `200`
When any of the mandatory input fields are missing, the API fails with HTTP status code `422 - Unprocessable content`
When minting fails due to insufficient MATIC balance, the API fails with custom HTTP status code `420`
Success
Invalid Input
Insufficient Balance
{
    "status": "success",
    "message": "Minting has been queued and will be added to blockchain. Please allow a few minutes for the transaction to be initiated and for asset to go live on blockchain",
    "data": []
}
{
    "status": "success",
    "message": "Minting has been queued and will be added to blockchain. Please allow a few minutes for the transaction to be initiated and for asset to go live on blockchain",
    "data": []
}
﻿
﻿

Parameter	Description	Required
api_key	Your API Key	Yes
contract_address	The smart contract address of the collection you would like to retrieve offers for	Yes
token_id	A specific token ID in the collection represented by the contract_address	No
chain	Options: ETH, SOL, MATIC If this is not provided, the API aims to use contract_address alone to determine chain	No
network	Options: mainnet, testnet If this is not provided, the API determines the chain network based on supplied contract_address	No

Parameter	Description	Required
api_key	Your API Key	Yes
owner_address	The owner address to retrieve offers for	Yes
scope	Options: account, global (requires special api_key permissions; contact: [email protected]) account: Returns offers for account that owns api_key global: Returns all offers that owner_address is eligible for	No
chain	Options: ETH, SOL, MATIC	No

Parameter	Description	Required
api_key	Your API Key	Yes
name	Name of the Collection/NFT	Yes
description	Short description of the NFT	Yes
asset_url	URL of the digital asset (image, audio, video etc) that is the NFT's creative	Yes
symbol	A unique symbol to identify the NFT (maximum of 8 characters)	Yes
website	Website for the NFT	No
network	Network to use; valid are testnet (default) and `mainnet`	No
transfer_address	Account address to which NFT will be tranferred after being minted (either a crypto address or an e-mail address)	No

Parameter	Description	Required
api_key	Your API Key	Yes
nftemplate_id	The nftemplate_id of the NFTemplate. To get the nftemplate_id click on the NFTemplate card from the NFT collection the NFTemplate is listed under to visit the NFTemplate Details screen and copy/paste from there	Yes
address	Wallet address to send NFT to after minting	Yes, if no email param is provided
email	Email address to send NFT to after minting	Yes, if no address param is provided
flow	Options: claim, direct claim: User must claim via claim page direct: Automatically delivers NFT to user via email; requires email param to be present	No (defaults to claim)

Updated 08 Apr 2024

Flutter

Creating an API Key