Quick Start

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

For now, please contact us to apply for your API key.

Make your first request

To make your first request, send an authenticated request to the pets endpoint. This will create a pet, which is nice.

Register through purse.

POST https://api.metaforo.io/v2/purse/register

Register through purse.

Request Body

Name	Type	Description
web3_public_key*	String	public key acquired through purse.
api_key*	String	The API KEY that assigned to you.
username*	String	Name of the user.
photo_url	String	Uploaded photo's url

200 Successfully registered

{
    "status": true,
    "code": "20000",
    "description": "",
    "server": "rest",
    "data": {
        "user": {
            "id": 26962,
            "name": "chaochen",
            "email": "[email protected]",
            "is_nfc": 0,
            "photo_url": "https://metaforo.io/img/default_avatar_5.png",
            "likes": 0,
            "posts": 0,
            "activate": 1,
            "last_post_time": null,
            "stripe_cus_id": "",
            "group_perm_level": [],
            "groups": [],
            "ban_group": [],
            "can_join_group": [],
            "blocked_users": [],
            "api_version": "99",
            "super_admin": 0,
            "settings": null,
            "phantom_address": "",
            "ar_address": "",
            "dark_mode": 1,
            "referral_url": "https://www.metaforo.io/landing?method=referral&data=26962&sign=3254d81e597d3b395c21423dff4540a9"
        }
    }
}

401 Permission denied

Good to know: You can use the API Method block to fully document an API method. You can also sync your API blocks with an OpenAPI file or URL to auto-populate them.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://api.metaforo.io/v2/purse/login  
    -u YOUR_API_KEY:  
    -d web3_public_key='AEd02566c3056242196E6e68D03CAAcEB78002' 
    -d username='test_user'
    -d photo_url='https://cdn.everforo.com/20220601/32d10f16fd278a91aabef3cb7a7392e7.png'

Node

// require the myapi module and set it up with your API key
const myapi = require('myapi')(YOUR_API_KEY);

const newUser = away myapi.pet.create({
    web3_public_key: 'AEd02566c3056242196E6e68D03CAAcEB78002',
    username: 'test_user',
    photo_url: 'https://cdn.everforo.com/20220601/32d10f16fd278a91aabef3cb7a7392e7.png',
})

Python

// Set your API key before making the request
myapi.api_key = YOUR_API_KEY

myapi.NewUser.create(
    web3_public_key='AEd02566c3056242196E6e68D03CAAcEB78002',
    username='test_user'
    photo_url='https://cdn.everforo.com/20220601/32d10f16fd278a91aabef3cb7a7392e7.png'
)