SPYCE.5
Developer Quickstart Guide

Get started in 30 seconds
Login to your registered account on pro.spyce5.com and navigate to the API Key Section.
﻿
1. 🔑 Create an API Key
Before making requests to the SPYCE.5 platform, you need an authentication key. This key ensures secure communication with the platform.
🎁 We have already created a first personal API for you.  
Your first API key is already available
﻿
The creation of additional API keys is available in the Business and Enterprise plan.
2. ✍️ Send a Block
1️⃣ MAINNET (Layer1)
2️⃣ ShimmerEVM (Layer2)
With your key ready, you can send a block to the SPYCE.5 platform using the curl command. Here's a template, filled out for the Shimmer Network:
curl -v -X \
 POST 'https://shimmer.spyce5.com/api/core/v2/blocks' -H 'content-type: application/json' \
 -H 'authorization: YOUR_SPYCE.5_API_KEY' \
 -d '{"protocolVersion":2, "payload": { "type":5, "index":"484f524e4554205370616d6d6572", "data":"0x535059434520495420555021" }}'
Replace YOUR_SPYCE.5_API_KEY with the key you copied in the first step.
Feel free to change the "data", it's hex encoded. 
The response of the API call contains the block ID under which your data was immutably recorded on the IOTA Ledger. Copy and paste your blockid into the Shimmer Explorer to view your trainsaction.
🎉 Congratulations, you have saved your first transaction immutably on the the blockchain.
Will be added soon
﻿
3. 🤝 Connect via IOTA-SDK
To connect to your API-Endpoint through the IOTA SDK into your project, ensure that your client or application is set up to interact with the SPYCE.5 endpoint.
After you installed the library, you can create a Client instance and interface with it.
In your client configuration, set the base URL to your API endpoint:
Node.js
Text
import { Client } from '@iota/sdk';

// Run with command:
// yarn run-example ./client/getting-started.ts

// In this example we will get information about the node
async function run() {
    const client = new Client({
        // Your Endpoint / API-KEY 
        nodes: ['https://shimmer.spyce5.com/YOUR_SPYCE.5_API_KEY'],
    });

    try {
        const nodeInfo = (await client.getInfo()).nodeInfo;
        console.log(nodeInfo);
    } catch (error) {
        console.error('Error: ', error);
    }
}

run().then(() => process.exit());
import { Client } from '@iota/sdk';

// Run with command:
// yarn run-example ./client/getting-started.ts

// In this example we will get information about the node
async function run() {
    const client = new Client({
        // Your Endpoint / API-KEY 
        nodes: ['https://shimmer.spyce5.com/YOUR_SPYCE.5_API_KEY'],
    });

    try {
        const nodeInfo = (await client.getInfo()).nodeInfo;
        console.log(nodeInfo);
    } catch (error) {
        console.error('Error: ', error);
    }
}

run().then(() => process.exit());
﻿
Replace YOUR_SPYCE.5_API_KEY with the key you copied in the first step.
4. 🚀 Start Building!
With SPYCE.5 set up, you're ready to build and innovate. Dive into the detailed documentation to explore advanced features, best practices, and tips to make the most of your project!
﻿
5. 💪 Join the Community
Join the community through discord:
IOTA Discord: https://discord.iota.org﻿
SPYCE.5 Discord: https://discord.spyce5.com﻿
﻿
Updated 08 Nov 2023
Did this page help you?
SPYCE.5 Guide
The SPYCE.5 Platform
Docs powered by Archbee
TABLE OF CONTENTS
Get started in 30 seconds
1. 🔑 Create an API Key
2. ✍️ Send a Block
3. 🤝 Connect via IOTA-SDK
4. 🚀 Start Building!
5. 💪 Join the Community