blob: 86be02f037eb376969dabe1e04565d2209482dcc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<script>
import { copyNoNewlines as copy } from '$lib/utils';
import { Code, Icon } from '$comp';
import { PUBLIC_COINOS_URL } from '$env/static/public';
export let data;
let { user, token } = data;
let api = 'https://coinos.io/api';
let tokenSample = token ? `export token="${token}"` : `export token=<your auth token>`;
</script>
<div class="space-y-8 lg:text-xl mt-20 pt-20 md:pt-0 w-full max-w-full">
<h1 class="text-4xl">Documentation</h1>
<p class="text-secondary">
Coinos has a simple REST API that can be used to register accounts and make payments and
queries. The following examples show how you can call the API with <a href="https://curl.se/" class="font-bold">curl</a> from your command line.
</p>
<h2 class="text-2xl">API Base URL</h2>
<div class="bg-black text-white rounded-lg p-4 flex gap-4">
<div>{api}</div>
<button class="ml-auto my-auto invert opacity-90" on:click={() => copy(api)}
><Icon icon="copy" style="w-10 max-w-none" /></button
>
</div>
<h2 class="text-2xl">Auth Token</h2>
<p class="text-secondary">
{#if user && token}
This token authorizes you to use the API as <b>{user.username}</b>.
{:else}
<a href="/login" class="font-bold">Sign in</a> to view your auth token here, or get one from the /login endpoint.
{/if}
Save it in a variable called <b>$token</b> to run the examples.
</p>
<div class="bg-black text-white rounded-lg p-4 flex gap-4">
<div class="w-full break-all">{tokenSample}</div>
<button class="ml-auto my-auto invert opacity-90" on:click={() => copy(tokenSample)}
><Icon icon="copy" style="w-10 max-w-none" /></button
>
</div>
<h2 class="text-2xl">POST /register</h2>
<p class="text-secondary">Register a new user account with a username and password</p>
<Code sample="register" />
<h2 class="text-2xl">POST /login</h2>
<p class="text-secondary">Login to an account to get its auth token</p>
<Code sample="login" />
<h2 class="text-2xl">POST /invoice</h2>
<p class="text-secondary">Create an invoice.</p>
<div class="text-secondary">
<div>Request params</div>
<div class="grid grid-cols-3 ml-2">
<div class="font-bold">type</div>
<div class="col-span-2">bitcoin or lightning</div>
<div class="font-bold">amount</div>
<div class="col-span-2">amount in satoshis</div>
<div class="font-bold">webhook</div>
<div class="col-span-2">(optional) endpoint to hit when the invoice is paid</div>
<div class="font-bold">secret</div>
<div class="col-span-2">a secret for the webhook to check</div>
</div>
</div>
<p>Get a lightning invoice to receive funds</p>
<Code sample="lightningInvoice" />
<p>Get a bitcoin address to receive funds</p>
<Code sample="bitcoinAddress" />
<p>Sample response</p>
<Code sample="invoiceResponse" />
<p>You can check the <b>received</b> field to see how much has been paid</p>
<p>Specify a webhook to be called when an invoice is paid</p>
<Code sample="webhook" />
<h2 class="text-2xl">GET /invoice/:hash</h2>
<p class="text-secondary">
Fetch an invoice by passing a bitcoin address or lightning payment hash
</p>
<Code sample="fetchInvoice" />
<h2 class="text-2xl">POST /payments</h2>
<p class="text-secondary">Send a lightning payment</p>
<Code sample="lightning" />
<p class="text-secondary">Send a bitcoin payment</p>
<Code sample="bitcoin" />
<p class="text-secondary">Send an internal payment to another user</p>
<Code sample="internal" />
<h2 class="text-2xl">GET /payments</h2>
<p class="text-secondary">Get all payments sent or received by the current user</p>
<div class="text-secondary">
<div>Query params</div>
<div class="grid grid-cols-3 ml-2">
<div class="font-bold">start</div>
<div class="col-span-2">only payments after this unix time</div>
<div class="font-bold">end</div>
<div class="col-span-2">only payments before this unix time</div>
<div class="font-bold">limit</div>
<div class="col-span-2">limit to this integer number of results</div>
<div class="font-bold">offset</div>
<div class="col-span-2">start limiting from this integer offset</div>
</div>
</div>
<Code sample="payments" />
</div>
|
