Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Section: Partner Integrations #53

Closed
wants to merge 10 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: API Reference v2
  • Loading branch information
emmaodia committed Dec 11, 2023
commit a732013e20851815c753af86bd5919aad114d9e0
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ components:
type: http
scheme: bearer
paths:
/api/v1/smart-wallets/auth:
/api/v2/smart-wallets/auth:
post:
tags:
- Smart Wallets
- Smart Wallet
summary: Auth
description: Authenticate user using signed data standard EIP-191
requestBody:
Expand Down Expand Up @@ -79,7 +79,7 @@ paths:
error: Forbidden
path: >-
/api/v2/smart-wallet/auth?apiKey={{publicKey}}
/api/v1/smart-wallets/historical_txs:
/api/v2/smart-wallets/actions:
get:
tags:
- Smart Wallets
Expand Down
223 changes: 111 additions & 112 deletions docs/smart-wallet-api-v/auth.api.mdx
Original file line number Diff line number Diff line change
@@ -1,199 +1,199 @@
---
id: auth
title: 'Auth'
description: 'Authenticate user using signed data standard EIP-191'
sidebar_label: 'Auth'
title: "Auth"
description: "Authenticate user using signed data standard EIP-191"
sidebar_label: "Auth"
hide_title: true
hide_table_of_contents: true
api:
{
'tags': ['Smart Wallets'],
'description': 'Authenticate user using signed data standard EIP-191',
'requestBody':
"tags": ["Smart Wallets"],
"description": "Authenticate user using signed data standard EIP-191",
"requestBody":
{
'content':
"content":
{
'application/json':
"application/json":
{
'schema':
"schema":
{
'type': 'object',
'properties':
"type": "object",
"properties":
{
'hash':
"hash":
{
'type': 'string',
'example': '0xf9054fd2b85014d5abf30608cf2d8f9712232d203b427a7c46c6785710f880d9',
"type": "string",
"example": "0xf9054fd2b85014d5abf30608cf2d8f9712232d203b427a7c46c6785710f880d9",
},
'signature':
"signature":
{
'type': 'string',
'example': '0x387810a84b3f39d9b79d08c7a2095e0a60c200199b0355e1199630ca1e623cf7564a4e3126a01ff43472399cf7087a361c44a3c125f216ed82cae175951243431b',
"type": "string",
"example": "0x387810a84b3f39d9b79d08c7a2095e0a60c200199b0355e1199630ca1e623cf7564a4e3126a01ff43472399cf7087a361c44a3c125f216ed82cae175951243431b",
},
'ownerAddress':
"ownerAddress":
{
'type': 'string',
'example': '0x199DC49d8187EeA58649F7cA387e2226d4155C94',
"type": "string",
"example": "0x199DC49d8187EeA58649F7cA387e2226d4155C94",
},
},
'example':
"example":
{
'hash': '0xf9054fd2b85014d5abf30608cf2d8f9712232d203b427a7c46c6785710f880d9',
'signature': '0x387810a84b3f39d9b79d08c7a2095e0a60c200199b0355e1199630ca1e623cf7564a4e3126a01ff43472399cf7087a361c44a3c125f216ed82cae175951243431b',
'ownerAddress': '0x199DC49d8187EeA58649F7cA387e2226d4155C94',
"hash": "0xf9054fd2b85014d5abf30608cf2d8f9712232d203b427a7c46c6785710f880d9",
"signature": "0x387810a84b3f39d9b79d08c7a2095e0a60c200199b0355e1199630ca1e623cf7564a4e3126a01ff43472399cf7087a361c44a3c125f216ed82cae175951243431b",
"ownerAddress": "0x199DC49d8187EeA58649F7cA387e2226d4155C94",
},
},
},
},
},
'parameters':
"parameters":
[
{
'name': 'apiKey',
'in': 'query',
'schema': { 'type': 'string' },
'description': '(Required) Your Public API key',
'example': '{{publicKey}}',
"name": "apiKey",
"in": "query",
"schema": { "type": "string" },
"description": "(Required) Your Public API key",
"example": "{{publicKey}}",
},
],
'responses':
"responses":
{
'201':
"201":
{
'description': 'Created',
'content':
"description": "Created",
"content":
{
'application/json':
"application/json":
{
'schema': { 'type': 'object' },
'example':
"schema": { "type": "object" },
"example":
{
'jwt': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvd25lckFkZHJlc3MiOiIweDgwOUI3ODM3MWY1MGYyOEQyQzYxRjYzZTQ4YjU4YjdFZTA1M0UzRWEiLCJwcm9qZWN0SWQiOiI2M2NkMWJjMWQxOGMxNjQyMmJiOGMwYzMiLCJpYXQiOjE2NzUzMjcxOTR9.-iWIEN6OLyCI4j5WOA8V2mH3KQtrmEoUGhIS4migV9g',
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvd25lckFkZHJlc3MiOiIweDgwOUI3ODM3MWY1MGYyOEQyQzYxRjYzZTQ4YjU4YjdFZTA1M0UzRWEiLCJwcm9qZWN0SWQiOiI2M2NkMWJjMWQxOGMxNjQyMmJiOGMwYzMiLCJpYXQiOjE2NzUzMjcxOTR9.-iWIEN6OLyCI4j5WOA8V2mH3KQtrmEoUGhIS4migV9g",
},
},
},
},
'400':
"400":
{
'description': 'Bad Request',
'content':
"description": "Bad Request",
"content":
{
'application/json':
"application/json":
{
'schema': { 'type': 'object' },
'example':
"schema": { "type": "object" },
"example":
{
'statusCode': 400,
'errorMessage': 'Owner Address does not match recovered address in signature',
'path': '/api/v1/smart-wallets/auth?apiKey={{publicKey}}',
"statusCode": 400,
"errorMessage": "Owner Address does not match recovered address in signature",
"path": "/api/v2/smart-wallets/auth?apiKey={{publicKey}}",
},
},
},
},
'403':
"403":
{
'description': 'Forbidden',
'content':
"description": "Forbidden",
"content":
{
'application/json':
"application/json":
{
'schema': { 'type': 'object' },
'example':
"schema": { "type": "object" },
"example":
{
'statusCode': 403,
'errorMessage':
"statusCode": 403,
"errorMessage":
{
'statusCode': 403,
'message': 'Forbidden resource',
'error': 'Forbidden',
"statusCode": 403,
"message": "Forbidden resource",
"error": "Forbidden",
},
'path': '/api/v1/smart-wallets/auth?apiKey={{publicKey}}',
"path": "/api/v2/smart-wallets/auth?apiKey={{publicKey}}",
},
},
},
},
},
'method': 'post',
'path': '/api/v1/smart-wallets/auth',
'servers': [{ 'url': 'https://api.fuse.io' }],
'securitySchemes':
"method": "post",
"path": "/api/v2/smart-wallets/auth",
"servers": [{ "url": "https://api.fuse.io" }],
"securitySchemes":
{
'bearerAuth':
{ 'bearerFormat': 'JWT', 'type': 'http', 'scheme': 'bearer' },
"bearerAuth":
{ "bearerFormat": "JWT", "type": "http", "scheme": "bearer" },
},
'jsonRequestBodyExample':
"jsonRequestBodyExample":
{
'hash': '0xf9054fd2b85014d5abf30608cf2d8f9712232d203b427a7c46c6785710f880d9',
'signature': '0x387810a84b3f39d9b79d08c7a2095e0a60c200199b0355e1199630ca1e623cf7564a4e3126a01ff43472399cf7087a361c44a3c125f216ed82cae175951243431b',
'ownerAddress': '0x199DC49d8187EeA58649F7cA387e2226d4155C94',
"hash": "0xf9054fd2b85014d5abf30608cf2d8f9712232d203b427a7c46c6785710f880d9",
"signature": "0x387810a84b3f39d9b79d08c7a2095e0a60c200199b0355e1199630ca1e623cf7564a4e3126a01ff43472399cf7087a361c44a3c125f216ed82cae175951243431b",
"ownerAddress": "0x199DC49d8187EeA58649F7cA387e2226d4155C94",
},
'info': { 'title': 'Smart Wallets API', 'version': '1.0.0' },
'postman':
"info": { "title": "Smart Wallets API", "version": "1.0.0" },
"postman":
{
'name': 'Auth',
'description':
"name": "Auth",
"description":
{
'content': 'Authenticate user using signed data standard EIP-191',
'type': 'text/plain',
"content": "Authenticate user using signed data standard EIP-191",
"type": "text/plain",
},
'url':
"url":
{
'path': ['api', 'v1', 'smart-wallets', 'auth'],
'host': ['{{baseUrl}}'],
'query':
"path": ["api", "v2", "smart-wallets", "auth"],
"host": ["{{baseUrl}}"],
"query":
[
{
'disabled': false,
'description':
"disabled": false,
"description":
{
'content': '(Required) Your Public API key',
'type': 'text/plain',
"content": "(Required) Your Public API key",
"type": "text/plain",
},
'key': 'apiKey',
'value': '',
"key": "apiKey",
"value": "",
},
],
'variable': [],
"variable": [],
},
'header':
"header":
[
{ 'key': 'Content-Type', 'value': 'application/json' },
{ 'key': 'Accept', 'value': 'application/json' },
{ "key": "Content-Type", "value": "application/json" },
{ "key": "Accept", "value": "application/json" },
],
'method': 'POST',
'body':
"method": "POST",
"body":
{
'mode': 'raw',
'raw': '""',
'options': { 'raw': { 'language': 'json' } },
"mode": "raw",
"raw": '""',
"options": { "raw": { "language": "json" } },
},
},
}
sidebar_class_name: 'post api-method'
sidebar_class_name: "post api-method"
info_path: docs/smart-wallet-api/smart-wallets-api
custom_edit_url: null
---

import ApiTabs from '@theme/ApiTabs'
import DiscriminatorTabs from '@theme/DiscriminatorTabs'
import MethodEndpoint from '@theme/ApiDemoPanel/MethodEndpoint'
import SecuritySchemes from '@theme/ApiDemoPanel/SecuritySchemes'
import MimeTabs from '@theme/MimeTabs'
import ParamsItem from '@theme/ParamsItem'
import ResponseSamples from '@theme/ResponseSamples'
import SchemaItem from '@theme/SchemaItem'
import SchemaTabs from '@theme/SchemaTabs'
import TabItem from '@theme/TabItem'
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint";
import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={'openapi__heading'}>Auth</h1>
<h1 className={"openapi__heading"}>Auth</h1>

<MethodEndpoint
method={'post'}
path={'/api/v1/smart-wallets/auth'}
method={"post"}
path={"/api/v2/smart-wallets/auth"}
></MethodEndpoint>

<SecuritySchemes
infoPath={'docs/smart-wallet-api/smart-wallets-api'}
infoPath={"docs/smart-wallet-api/smart-wallets-api"}
></SecuritySchemes>

Authenticate user using signed data standard EIP-191
Expand All @@ -208,9 +208,8 @@ Created

Bad Request

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div><strong>object</strong></div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"statusCode\": 400,\n \"errorMessage\": \"Owner Address does not match recovered address in signature\",\n \"path\": \"/api/v1/smart-wallets/auth?apiKey={{publicKey}}\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div><strong>object</strong></div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"statusCode\": 400,\n \"errorMessage\": \"Owner Address does not match recovered address in signature\",\n \"path\": \"/api/v2/smart-wallets/auth?apiKey={{publicKey}}\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div><strong>object</strong></div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"statusCode\": 403,\n \"errorMessage\": {\n \"statusCode\": 403,\n \"message\": \"Forbidden resource\",\n \"error\": \"Forbidden\"\n },\n \"path\": \"/api/v1/smart-wallets/auth?apiKey={{publicKey}}\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div><strong>object</strong></div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"statusCode\": 403,\n \"errorMessage\": {\n \"statusCode\": 403,\n \"message\": \"Forbidden resource\",\n \"error\": \"Forbidden\"\n },\n \"path\": \"/api/v2/smart-wallets/auth?apiKey={{publicKey}}\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Loading