Rpc api что это

Use saved searches to filter your results more quickly

Cancel Create saved search

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window.

Reload to refresh your session.

This repository has been archived by the owner on May 26, 2022. It is now read-only.

ethereum / wiki Public archive

JSON RPC

Felix Lange edited this page Jul 17, 2019 · 364 revisions

  • Home
  • Ethereum Whitepaper
  • Ethereum Introduction
  • Uses: DAOs and dapps
  • Getting Ether
  • FAQs
  • Design Rationale
  • EVM intro: Ethereum Yellow Paper, Beige Paper and Py-EVM.
  • Wiki for (old) website (still a good introduction)
  • Glossary
  • Sharding introduction D Compendium, FAQs —rpcport portnumber>

    If accessing the RPC from a browser, CORS will need to be enabled with the appropriate domain set. Otherwise, JavaScript calls are limit by the same-origin policy and requests will fail:

    RPC и REST — в чём разница? Часть 1: RPC


    geth —rpc —rpccorsdomain «http://localhost:3000»

    The JSON RPC can also be started from the geth console using the admin.startRPC(addr, port) command.

    First start the node by running aleth application:

    build/aleth/aleth

    Then start the JSON-RPC proxy (defaults to ‘~/.ethereum/geth.ipc’ and ‘http://127.0.0.1:8545’):

    scripts/jsonrpcproxy.py

    If you use non-default IPC path or JSON-RPC options, you can specify :

    scripts/jsonrpcproxy.py path to your node’s geth.ipc>

    In python the JSONRPC server is currently started by default and listens on 127.0.0.1:4000

    You can change the port and listen address by giving a config option.

    pyethapp -c jsonrpc.listen_port=4002 -c jsonrpc.listen_host=127.0.0.2 run

    cpp-ethereum go-ethereum py-ethereum parity pantheon
    JSON-RPC 1.0 ✓
    JSON-RPC 2.0 ✓ ✓ ✓ ✓ ✓
    Batch requests ✓ ✓ ✓ ✓ ✓
    HTTP ✓ ✓ ✓ ✓ ✓
    IPC ✓ ✓ ✓
    WS ✓ ✓ ✓

    HEX value encoding

    At present there are two key datatypes that are passed over JSON: unformatted byte arrays and quantities. Both are passed with a hex encoding, however with different requirements to formatting:

    When encoding QUANTITIES (integers, numbers): encode as hex, prefix with «0x», the most compact representation (slight exception: zero should be represented as «0x0»). Examples:

    RPC? — Это просто!

    • 0x41 (65 in decimal)
    • 0x400 (1024 in decimal)
    • WRONG: 0x (should always have at least one digit — zero is «0x0»)
    • WRONG: 0x0400 (no leading zeroes allowed)
    • WRONG: ff (must be prefixed 0x)

    When encoding UNFORMATTED DATA (byte arrays, account addresses, hashes, bytecode arrays): encode as hex, prefix with «0x», two hex digits per byte. Examples:

    • 0x41 (size 1, «A»)
    • 0x004200 (size 3, «B»)
    • 0x (size 0, «»)
    • WRONG: 0xf0f0f (must be even number of digits)
    • WRONG: 004200 (must be prefixed 0x)

    Currently cpp-ethereum,go-ethereum and parity provide JSON-RPC communication over http and IPC (unix socket Linux and OSX/named pipes on Windows). Version 1.4 of go-ethereum, version 1.6 of Parity and version 0.8 of Pantheon onwards have websocket support.

    The default block parameter

    The following methods have an extra default block parameter:

    • eth_getBalance
    • eth_getCode
    • eth_getTransactionCount
    • eth_getStorageAt
    • eth_call

    When requests are made that act on the state of ethereum, the last default block parameter determines the height of the block.

    The following options are possible for the defaultBlock parameter:

    • HEX String — an integer block number
    • String «earliest» for the earliest/genesis block
    • String «latest» — for the latest mined block
    • String «pending» — for the pending state/transactions

    Curl Examples Explained

    The curl options below might return a response where the node complains about the content type, this is because the —data option sets the content type to application/x-www-form-urlencoded . If your node does complain, manually set the header by placing -H «Content-Type: application/json» at the start of the call.

    The examples also do not include the URL/IP «jsonrpc»:»2.0″,»method»:»web3_clientVersion»,»params»:[],»id»:67>’ // Result «id»:67, «jsonrpc»:»2.0″, «result»: «Mist/v0.9.3/darwin/go1.4.1» >

    Returns Keccak-256 (not the standardized SHA3-256) of the given data.

    1. DATA — the data to convert into a SHA3 hash.

    params: [ «0x68656c6c6f20776f726c64» ]

    DATA — The SHA3 result of the given string.

    // Request curl -X POST —data » // Result «id»:64, «jsonrpc»: «2.0», «result»: «0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad» >

    Returns the current network id.

    String — The current network id.

    • «1» : Ethereum Mainnet
    • «2» : Morden Testnet (deprecated)
    • «3» : Ropsten Testnet
    • «4» : Rinkeby Testnet
    • «42» : Kovan Testnet

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»net_version»,»params»:[],»id»:67>’ // Result «id»:67, «jsonrpc»: «2.0», «result»: «3» >

    Returns true if client is actively listening for network connections.

    Boolean — true when listening, otherwise false .

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»net_listening»,»params»:[],»id»:67>’ // Result «id»:67, «jsonrpc»:»2.0″, «result»:true >

    Returns number of peers currently connected to the client.

    QUANTITY — integer of the number of connected peers.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»net_peerCount»,»params»:[],»id»:74>’ // Result «id»:74, «jsonrpc»: «2.0», «result»: «0x2» // 2 >

    Returns the current ethereum protocol version.

    String — The current ethereum protocol version.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_protocolVersion»,»params»:[],»id»:67>’ // Result «id»:67, «jsonrpc»: «2.0», «result»: «0x54» >

    Returns an object with data about the sync status or false .

    Object|Boolean , An object with sync status data or FALSE , when not syncing:

    • startingBlock : QUANTITY — The block at which the import started (will only be reset, after the sync reached his head)
    • currentBlock : QUANTITY — The current block, same as eth_blockNumber
    • highestBlock : QUANTITY — The estimated highest block

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_syncing»,»params»:[],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: startingBlock: ‘0x384’, currentBlock: ‘0x386’, highestBlock: ‘0x454’ > > // Or when not syncing «id»:1, «jsonrpc»: «2.0», «result»: false >

    Returns the client coinbase address.

    DATA , 20 bytes — the current coinbase address.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_coinbase»,»params»:[],»id»:64>’ // Result «id»:64, «jsonrpc»: «2.0», «result»: «0xc94770007dda54cF92009BFF0dE90c06F603a09f» >

    Returns true if client is actively mining new blocks.

    Boolean — returns true of the client is mining, otherwise false .

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_mining»,»params»:[],»id»:71>’ // Result «id»:71, «jsonrpc»: «2.0», «result»: true >

    Returns the number of hashes per second that the node is mining with.

    QUANTITY — number of hashes per second.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_hashrate»,»params»:[],»id»:71>’ // Result «id»:71, «jsonrpc»: «2.0», «result»: «0x38a» >

    Returns the current price per gas in wei.

    QUANTITY — integer of the current gas price in wei.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_gasPrice»,»params»:[],»id»:73>’ // Result «id»:73, «jsonrpc»: «2.0», «result»: «0x09184e72a000» // 10000000000000 >

    Returns a list of addresses owned by client.

    Array of DATA , 20 Bytes — addresses owned by the client.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_accounts»,»params»:[],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: [«0xc94770007dda54cF92009BFF0dE90c06F603a09f»] >

    Returns the number of most recent block.

    QUANTITY — integer of the current block number the client is on.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_blockNumber»,»params»:[],»id»:1>’ // Result «id»:83, «jsonrpc»: «2.0», «result»: «0xc94» // 1207 >

    Returns the balance of the account of given address.

    1. DATA , 20 Bytes — address to check for balance.
    2. QUANTITY|TAG — integer block number, or the string «latest» , «earliest» or «pending» , see the default block parameter

    params: [ ‘0xc94770007dda54cF92009BFF0dE90c06F603a09f’, ‘latest’ ]

    QUANTITY — integer of the current balance in wei.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_getBalance»,»params»:[«0xc94770007dda54cF92009BFF0dE90c06F603a09f», «latest»],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: «0x0234c8a3397aab58» // 158972490234375000 >

    Returns the value from a storage position at a given address.

    1. DATA , 20 Bytes — address of the storage.
    2. QUANTITY — integer of the position in the storage.
    3. QUANTITY|TAG — integer block number, or the string «latest» , «earliest» or «pending» , see the default block parameter

    DATA — the value at this storage position.

    Calculating the correct position depends on the storage to retrieve. Consider the following contract deployed at 0x295a70b2de5e3953354a6a8344e616ed314d7251 by address 0x391694e7e0b0cce554cb130d723a9d27458f9298 .

    contract Storage < uint pos0; mapping(address =>uint) pos1; function Storage() < pos0 = 1234; pos1[msg.sender] = 5678; >>

    Retrieving the value of pos0 is straight forward:

    curl -X POST —data » localhost:8545 «jsonrpc»:»2.0″,»id»:1,»result»:»0x00000000000000000000000000000000000000000000000000000000000004d2″>

    Retrieving an element of the map is harder. The position of an element in the map is calculated with:

    keccack(LeftPad32(key, 0), LeftPad32(map position, 0))

    This means to retrieve the storage on pos1[«0x391694e7e0b0cce554cb130d723a9d27458f9298»] we need to calculate the position with:

    keccak(decodeHex(«000000000000000000000000391694e7e0b0cce554cb130d723a9d27458f9298» + «0000000000000000000000000000000000000000000000000000000000000001»))

    The geth console which comes with the web3 library can be used to make the calculation:

    > var key = «000000000000000000000000391694e7e0b0cce554cb130d723a9d27458f9298» + «0000000000000000000000000000000000000000000000000000000000000001» undefined > web3.sha3(key, «encoding»: «hex»>) «0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9»

    Now to fetch the storage:

    curl -X POST —data » localhost:8545 «jsonrpc»:»2.0″,»id»:1,»result»:»0x000000000000000000000000000000000000000000000000000000000000162e»>

    Returns the number of transactions sent from an address.

    1. DATA , 20 Bytes — address.
    2. QUANTITY|TAG — integer block number, or the string «latest» , «earliest» or «pending» , see the default block parameter

    params: [ ‘0xc94770007dda54cF92009BFF0dE90c06F603a09f’, ‘latest’ // state at the latest block ]

    QUANTITY — integer of the number of transactions send from this address.

    // Request curl -X POST —data » // Result «id»:1, «jsonrpc»: «2.0», «result»: «0x1» // 1 >

    Returns the number of transactions in a block from a block matching the given block hash.

    1. DATA , 32 Bytes — hash of a block.

    params: [ ‘0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238’ ]

    QUANTITY — integer of the number of transactions in this block.

    // Request curl -X POST —data » // Result «id»:1, «jsonrpc»: «2.0», «result»: «0xc» // 11 >

    Returns the number of transactions in a block matching the given block number.

    1. QUANTITY|TAG — integer of a block number, or the string «earliest» , «latest» or «pending» , as in the default block parameter.

    params: [ ‘0xe8’, // 232 ]

    QUANTITY — integer of the number of transactions in this block.

    // Request curl -X POST —data » // Result «id»:1, «jsonrpc»: «2.0», «result»: «0xa» // 10 >

    Returns the number of uncles in a block from a block matching the given block hash.

    1. DATA , 32 Bytes — hash of a block.

    params: [ ‘0xc94770007dda54cF92009BFF0dE90c06F603a09f’ ]

    QUANTITY — integer of the number of uncles in this block.

    // Request curl -X POST —data » // Result «id»:1, «jsonrpc»: «2.0», «result»: «0xc» // 1 >

    Returns the number of uncles in a block from a block matching the given block number.

    1. QUANTITY|TAG — integer of a block number, or the string «latest», «earliest» or «pending», see the default block parameter.

    params: [ ‘0xe8’, // 232 ]

    QUANTITY — integer of the number of uncles in this block.

    // Request curl -X POST —data » // Result «id»:1, «jsonrpc»: «2.0», «result»: «0x1» // 1 >

    Returns code at a given address.

    1. DATA , 20 Bytes — address.
    2. QUANTITY|TAG — integer block number, or the string «latest» , «earliest» or «pending» , see the default block parameter.

    params: [ ‘0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b’, ‘0x2’ // 2 ]

    DATA — the code from the given address.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_getCode»,»params»:[«0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b», «0x2″],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: «0x600160008035811a818181146012578301005b601b6001356025565b8060005260206000f25b600060078202905091905056» >

    The sign method calculates an Ethereum specific signature with: sign(keccak256(«x19Ethereum Signed Message:n» + len(message) + message))) .

    By adding a prefix to the message makes the calculated signature recognisable as an Ethereum specific signature. This prevents misuse where a malicious DApp can sign arbitrary data (e.g. transaction) and use the signature to impersonate the victim.

    Note the address to sign with must be unlocked.

    1. DATA , 20 Bytes — address.
    2. DATA , N Bytes — message to sign.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_sign»,»params»:[«0x9b2055d370f73ec7d8a03e965129118dc8f5bf83», «0xdeadbeaf»],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: «0xa3f20717a250c2b0b729b7e5becbff67fdaef7e0699da4de7ca5895b02a170a12d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee1b» >

    An example how to use solidity ecrecover to verify the signature calculated with eth_sign can be found here. The contract is deployed on the testnet Ropsten and Rinkeby.

    Creates new message call transaction or a contract creation, if the data field contains code.

    1. Object — The transaction object
    • from : DATA , 20 Bytes — The address the transaction is send from.
    • to : DATA , 20 Bytes — (optional when creating new contract) The address the transaction is directed to.
    • gas : QUANTITY — (optional, default: 90000) Integer of the gas provided for the transaction execution. It will return unused gas.
    • gasPrice : QUANTITY — (optional, default: To-Be-Determined) Integer of the gasPrice used for each paid gas
    • value : QUANTITY — (optional) Integer of the value sent with this transaction
    • data : DATA — The compiled code of a contract OR the hash of the invoked method signature and encoded parameters. For details see Ethereum Contract ABI
    • nonce : QUANTITY — (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.

    params: [ «from»: «0xb60e8dd61c5d32be8058bb8eb970870f07233155», «to»: «0xd46e8dd67c5d32be8058bb8eb970870f07244567», «gas»: «0x76c0», // 30400 «gasPrice»: «0x9184e72a000», // 10000000000000 «value»: «0x9184e72a», // 2441406250 «data»: «0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675» >]

    DATA , 32 Bytes — the transaction hash, or the zero hash if the transaction is not yet available.

    Use eth_getTransactionReceipt to get the contract address, after the transaction was mined, when you created a contract.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_sendTransaction»,»params»:[],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: «0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331» >

    Creates new message call transaction or a contract creation for signed transactions.

    1. DATA , The signed transaction data.

    params: [«0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675»]

    DATA , 32 Bytes — the transaction hash, or the zero hash if the transaction is not yet available.

    Use eth_getTransactionReceipt to get the contract address, after the transaction was mined, when you created a contract.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_sendRawTransaction»,»params»:[],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: «0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331» >

    Executes a new message call immediately without creating a transaction on the block chain.

    1. Object — The transaction call object
    • from : DATA , 20 Bytes — (optional) The address the transaction is sent from.
    • to : DATA , 20 Bytes — The address the transaction is directed to.
    • gas : QUANTITY — (optional) Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
    • gasPrice : QUANTITY — (optional) Integer of the gasPrice used for each paid gas
    • value : QUANTITY — (optional) Integer of the value sent with this transaction
    • data : DATA — (optional) Hash of the method signature and encoded parameters. For details see Ethereum Contract ABI
    1. QUANTITY|TAG — integer block number, or the string «latest» , «earliest» or «pending» , see the default block parameter

    DATA — the return value of executed contract.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_call»,»params»:[],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: «0x» >

    Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.

    See eth_call parameters, expect that all properties are optional. If no gas limit is specified geth uses the block gas limit from the pending block as an upper bound. As a result the returned estimate might not be enough to executed the call/transaction when the amount of gas is higher than the pending block gas limit.

    QUANTITY — the amount of gas used.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_estimateGas»,»params»:[],»id»:1>’ // Result «id»:1, «jsonrpc»: «2.0», «result»: «0x5208» // 21000 >

    Returns information about a block by hash.

    1. DATA , 32 Bytes — Hash of a block.
    2. Boolean — If true it returns the full transaction objects, if false only the hashes of the transactions.

    params: [ ‘0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331’, true ]

    Object — A block object, or null when no block was found:

    • number : QUANTITY — the block number. null when its pending block.
    • hash : DATA , 32 Bytes — hash of the block. null when its pending block.
    • parentHash : DATA , 32 Bytes — hash of the parent block.
    • nonce : DATA , 8 Bytes — hash of the generated proof-of-work. null when its pending block.
    • sha3Uncles : DATA , 32 Bytes — SHA3 of the uncles data in the block.
    • logsBloom : DATA , 256 Bytes — the bloom filter for the logs of the block. null when its pending block.
    • transactionsRoot : DATA , 32 Bytes — the root of the transaction trie of the block.
    • stateRoot : DATA , 32 Bytes — the root of the final state trie of the block.
    • receiptsRoot : DATA , 32 Bytes — the root of the receipts trie of the block.
    • miner : DATA , 20 Bytes — the address of the beneficiary to whom the mining rewards were given.
    • difficulty : QUANTITY — integer of the difficulty for this block.
    • totalDifficulty : QUANTITY — integer of the total difficulty of the chain until this block.
    • extraData : DATA — the «extra data» field of this block.
    • size : QUANTITY — integer the size of this block in bytes.
    • gasLimit : QUANTITY — the maximum gas allowed in this block.
    • gasUsed : QUANTITY — the total used gas by all transactions in this block.
    • timestamp : QUANTITY — the unix timestamp for when the block was collated.
    • transactions : Array — Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
    • uncles : Array — Array of uncle hashes.

    // Request curl -X POST —data ‘<«jsonrpc»:»2.0″,»method»:»eth_getBlockByHash»,»params»:[«0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331″, true],»id»:1>’ // Result «id»:1, «jsonrpc»:»2.0″, «result»: «number»: «0x1b4», // 436 «hash»: «0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331», «parentHash»: «0x9646252be9520f6e71339a8df9c55e4d7619deeb018d2a3f2d21fc165dde5eb5», «nonce»: «0xe04d296d2460cfb8472af2c5fd05b5a214109c25688d3704aed5484f9a7792f2», «sha3Uncles»: «0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347», «logsBloom»: «0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331», «transactionsRoot»: «0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421», «stateRoot»: «0xd5855eb08b3387c0af375e9cdb6acfc05eb8f519e419b874b6ff2ffda7ed1dff», «miner»: «0x4e65fda2159562a496f9f3522f89122a3088497a», «difficulty»: «0x027f07», // 163591 «totalDifficulty»: «0x027f07», // 163591 «extraData»: «0x0000000000000000000000000000000000000000000000000000000000000000», «size»: «0x027f07», // 163591 «gasLimit»: «0x9f759», // 653145 «gasUsed»: «0x9f759», // 653145 «timestamp»: «0x54e34e8e» // 1424182926 «transactions»: [. >, . >] «uncles»: [«0x1606e5. «, «0xd5145a9. «] > >

    Returns information about a block by block number.

    1. QUANTITY|TAG — integer of a block number, or the string «earliest» , «latest» or «pending» , as in the default block parameter.
    2. Boolean — If true it returns the full transaction objects, if false only the hashes of the transactions.

    Источник: github.com

    Рельсы веб-интеграции — REST и SOAP

    Сервисы веб-интеграции (или веб-сервисы) — это технологии, при помощи которых различные системы передают друг другу данные (двусторонний обмен).

    9 из 10 веб-сервисов работают по HTTP или родительскому протоколу.

    В упрощенном виде, большинство запросов к таким сервисам — это стандартные ссылки, при помощи которых переходим к нужному ресурсу для обмена с конкретными базами или выполнения определенных действия.

    Одним из главных отличий веб-служб от простых HTTP запросов является наличие задокументированной четкой структуры с рядом общих стандартов. Например, если применять SOAP (строгое к правилам решение), то возможно сразу приступать к настройке структур БД и другим функциям, т.к. все начальные моменты учтены и решены.

    • XML-RPC (XML Remote Procedure Call) — протокол для удаленного доступа к использованию XML. Предшественник SOAP, прост в применении;
    • SOAP (Simple Object Access Protocol) — стандартный протокол версии W3C, который структурирован и весь задокументирован;
    • JSON–RPC (JSON Remote Procedure Call) — относительно современный вариант XML — RPC. Главное отличие состоит в том, что сведения передаются только в формате JSON;
    • REST (Representational State Transfer) — это архитектурный стиль, основанный на методах HTTP;
    • специализированные протоколы под конкретные задачи (GraphQL, OData, Ajax);
    • редко встречающийся, но эффективный gRPC — используется для передачи данных в двоичном виде и использует HTTP/2 в качестве транспорта.

    Здесь мы поговорим о том, что же такое SOAP и REST.

    Что такое SOAP

    Простыми словами SOAP (или Simple Object Access Protocol) – это простой протокол доступа к объектам, в котором не только вызов процедур, но и передача БД происходит в формате XML.

    • Envelope. Обязательный корневой элемент. Непосредственно он определяет сообщения и пространство времен;
    • Header. Он же заголовок. Не является обязательным элементом, но содержит необходимые атрибуты для обработки сообщения (информация об идентификаторе, маршрутизации или безопасности);
    • Body. Обязательный элемент, в котором содержится основная информация из сообщения;
    • Fault. Необязательный, но полезный элемент. В нем содержится информация об ошибках, которые возникают в процессе обработки сообщений.

    Преимущества SOAP

    Недостатки SOAP

    стандартизация по версии W3C

    сложно и долго парсить в XML

    понятная поддержка с продуктами Microsoft

    Что такое REST

    Representational State Transfer — примечание — это архитектурный стиль, а не протоколом. Простыми словами REST — это набор правил и условий для программиста. Если специалист придерживается этим условиям, настройка обмена данными его проекта с другими сервисами будет быстрой и безболезненной.

    Особенность REST — данные передаются в исходном виде, не требуя конвертации. Это создает нагрузку на сеть, но разгружает веб-сервер.

    • GET — получение;
    • POST — добавление;
    • PUT — изменение;
    • DELETE — удаление.

    На практике в 9 из 10 случаев используешь лишь 2 — GET, чтобы получить данные и POST для всего остального.

    Подсказка бывалого программиста

    Преимущества REST

    Недостатки REST

    прост в программировании

    нет больших требований к ресурсам

    сложно и долго парсить в XML

    нет требований к замысловатым программным надстройкам

    нет чётких методов для управления базами

    Чем же настроить веб-интеграцию?

    Так каким же методом интеграции правильно пользоваться?

    Для ответа на этот вопрос важно знать, над каким проектом идет работа.

    XML-RPC метод морально и технически устарел — JSON-RPC его заменяет куда более эффективно. При этом сами протоколы RPC применимы только в простейших системах, имеющих небольшое число информации и API-методов.

    SOAP популярен для комплексных корпоративных проектов, где применяется сложная замысловатая логика и необходимы единые стандарты, актуальные для продолжительного использования (комплексная автоматизация для больших предприятий создаётся годами).

    Но, самым распространенным в Сети является REST. И это объяснимо — когда “твой код” подчиняется правилам CRUD, интеграция с подавляющим большинством современных популярных сервисов запустится быстро. А с развитием спецификации OpenAPI и ряда инструментов Swagger, появилась возможность стандартизированного документирования разрабатываемого API, и даже тестирование взаимодействия с этим API без ожидания полноценной реализации.

    Веб-интеграция и Битрикс

    О применении и настройках различных интеграций сервисов и ресурсов на Битрикс мы написали отдельную статью с примерами.

    Чего там пока нет, но планируем дописать — 1С-Битрикс: Управление сайтом выпустили отдельный готовый модуль для работы с REST API.

    Использование REST и SOAP в больших бизнес-проектах

    Настройка интеграции различных веб-сервисов между собой — типичная задача для веб-интегратора ИНТЕРВОЛГА. Приведем пример использования SOAP и REST интеграций в рабочем проекте.

    Компания ЕВРАЗ — один из лидеров российского и мирового рынка металлопроката и металлоизделий. ИНТЕРВОЛГА уже много лет сотрудничает с этим металлургическим гигантом и создаёт для него инновационные автоматизированные веб-системы, применяя и REST и SOAP-технологии. А теперь перейдем к конкретике.

    Разработка Личного кабинета для партнеров ЕВРАЗ Металл Инпром. Учетная система компании выступает веб-клиентом, а сайт сервером. Интеграция и передача необходимых сведений настроена SOAP методом.

    Выводы

    Все технологии нужны, все методы важны. Главное — определить подходящий для вашего проекта вариант веб-интеграции и правильно его реализовать.

    Компания ИНТЕРВОЛГА — компетентный веб-интегратор, в которой собраны опытные программисты, способные подобрать и реализовать необходимые IT-решения для интеграции.

    Источник: www.intervolga.ru

    Что такое API простыми словами

    API – интерфейс, без которого было бы невозможно взаимодействие разных сервисов или программ. Он служит своеобразным посредником при передаче информации и может быть как у веб-сервисов и ОС, так и у языков программирования, чтобы они могли взаимодействовать между собой. Расскажем подробнее, что такое API сайта или приложения, какие разновидности существуют, где используются.

    Что такое API

    Что такое API? Аббревиатура расшифровывается, как Application Programming Interface, что переводится на русский как программный интерфейс приложения. Технически же этот инструмент – набор методик, позволяющих разным компонентам программ взаимодействовать между собой.

    Для обеспечения этого взаимодействия интерфейс API использует:

    • методы;
    • классы;
    • функции;
    • структуры;
    • константы.

    Упрощенный пример API – оплата товара в интернет-магазине. Когда покупатель оформляет заказ и подтверждает его, появляется форма для оплаты покупок, куда нужно вводить реквизиты карты. После ввода данных интернет-магазин использует API банка-эмитента карты, которому отправляет запрос на снятие определённой суммы со счёта. То есть, взаимодействие интернет-магазина и банковской системы происходит через API.

    Какие API бывают

    Приложение API имеет несколько разновидностей, которые отличаются по способу работы исходя из того, для чего и когда их создали.

    REST

    Самый распространённый вариант, высокопроизводительный, масштабируемый и надёжный. Его используют во всех ситуациях, когда пользователю, посетившему приложение или сайт, предоставляются данные с сервера. Для корректного отображения эти данные переводятся в один из форматов:

    Набор методов следующий:

    • функция чтения данных – GET;
    • создание объектов – POST;
    • замена и обновление данных – PUT;
    • удаление данных – DELETE.

    Основная особенность этой системы API – передача данных с веб-службы без сохранения состояния. В процессе используется клиентский запрос в виде URL-адреса (например, когда вы вводите запрос в строке поиска в браузере).

    SOAP

    Это расшифровывается как Simple Object Access Protocol, что означает API по простому протоколу. В то же время он сложнее предыдущего варианта. Работает только с данными, написанными на XML, в противном случае выдаёт ошибку. В основном используется с протоколами HTTP, но поддерживает также и SMTP, FTP, HTTPS. Основные структурные элементы SOAP-сообщения – Envelope, Header, Body и Fault.

    Он объединяет несколько различных стандартов, например, WS-Security (использование идентификаторов – токенов), WS-Addressing (метаданные о маршрутной информации) и др.

    RPC

    Что значит API RPC? Это такой же метод взаимодействия, но при вызове функции на удалённом сервере они как будто становятся локальными. Состоит из протокола обмена и сериализатора данных.

    HTTP здесь не служит частью API-сервиса, а выступает способом доставки. В RPC меньше кодов ответов и заголовков, а выполнение различных действий и обработка ошибок «встроены» в тело запроса и ответа.

    Примеры API

    Когда разобрались с основами API – что это такое простыми словами, где применяется и в каких разновидностях представлено, приведём несколько примеров.

    Google Календарь

    В приложениях-календарях для разных операционных систем синхронизация данных происходит через такие сервисы, как Google Календарь или Apple iCal для iOS и Android соответственно. Эта синхронизация и происходит с помощью функции API – программист получает возможность синхронизировать календари со сторонними приложениями напрямую.

    • устанавливать напоминания;
    • создавать события;
    • редактировать и удалять записи и др.

    Без API в данном случае установленный календарь работает автономно, информация со сторонних сервисов в него добавляться не будет.

    Погодное приложение

    Ещё один пример использования функционала API – приложение для просмотра прогноза погоды. Они могут быть сторонними, установленными из магазинов приложений или встроенными в ОС. Но вне зависимости от этого все они получают данные со стороннего источника.

    Есть сервисы, которые берут данные напрямую с сайтов метеостанций, но если речь о мобильных приложениях, то эти данные разработчики покупают и «заливают» через API. В процессе используются методы, которые дают возможность отправлять запросы о погоде в разных городах, эти запросы поступают на сервера метеостанции через приложение, в него же приходят «ответы», которые и видит пользователь.

    Сервис по заказу авиабилетов

    По такому же принципу работают сайты, приложения и агрегаторы для заказа авиабилетов. В них программа API используется для связи с серверами авиакомпаний. Например, в агрегаторах принцип такой – сервис собирает информацию в нескольких авиакомпаниях, объединяет данные по каждому направлению и показывает их списком в формате единого окна.

    В этом случае все сведения обновляются в режиме реального времени и показывают пользователю изменение цены на билеты, актуальные направления и др.

    Кнопки авторизации

    Простой пример кнопки авторизации – вход в личный кабинет на сайт через соцсети, например, профиль в ВК. В этом случае пользователь разрешает системе получить информацию о нём со стороннего ресурса, не указывая её вручную. Также с помощью кнопок соцсети можно регистрироваться на разных площадках.

    Этот процесс также происходит с помощью интерфейса прикладного программирования. Системе, где вы регистрируетесь или авторизуетесь, нужно получить данные о вас – ФИО, номер телефона, почту и др. Вы нажимаете кнопку соцсети, система запрашивает разрешение на получение информации, которое вы подтверждаете. В соцсети уходит запрос на предоставление данных, они автоматически подтягиваются в форму, и их не нужно вводить вручную. При этом существует набор функций для защиты данных, обеспечивается упрощенный способ авторизации.

    Принцип здесь похож на работу погодных приложений. Картографические данные предлагают крупные компании, например, Яндекс (Яндекс.Карты). Его API разработчики могут встраивать в свои продукты, после чего, например, когда вы ищете ближайшее отделение банка на его сайте или в приложении, открывается карта, на которой отмечены ваше месторасположение и ближайшие офисы.

    Но использование зависит от операционной системы. Например, в iOS-устройствах чаще используют Apple Maps, поскольку картографические данные предоставляет та же компания, что и ОС. Для Android чаще подключают карты от Google.

    Идеальное API

    Перед тем как пользоваться API, разработчики выбирают подходящий вариант и решают, какое API будет идеальным в данном случае.

    Бесшовность

    Универсального API, которое бы подходило всегда и везде, не существует. У каждой платформы есть свои особенности, из-за этого нельзя использовать единую программу для всех проектов.

    Но эту проблему решают следующим образом – пишут некий модуль-болванку, к которому добавляют код «по минимуму» с учётом особенностей конкретного проекта. Это значительно сокращает время разработчика.

    Быстродействие

    Под быстродействием понимают время, затраченное на достижение какого-либо результата. Например, когда пользователь регистрируется в соцсети, запрос о получении сведений о нём передаётся на сервер. При этом может потребоваться замена языка – они нередко отличаются на серверах и других платформах. Другой пример – API Google Translate обеспечивает перевод текста на Python.

    При этом используют промежуточный язык, чем обеспечивают возможность передачи данных. Обратная отправка происходит по той же схеме – сервер передаёт данные на одном языке, а сайт «принимает» их на другом.

    Это занимает определённое время. Чем меньше его тратится, тем более быстрым считается API.

    Понятность

    Каждая ссылка, метод или функция должны быть понятны всем, кто с ними взаимодействует. Это позволит сократить количество ошибок, а также уменьшить время на обработку запросов.

    Полнота

    «Правильное» API позволит разработчикам выполнять минимально необходимый объем операций, при этом сохранять точность перевода данных. Полнота API определяется тем, насколько полными будут ответы на выполненные действия.

    Как происходит вызов функций API

    В первую очередь необходимо разобраться в нюансах API – что это в программировании, как это работает. В помощь разработчикам приходит официальная документация, но она существует отдельно для каждого программного интерфейса – универсальных инструкций нет.

    Существуют прямые и непрямые методы вызова API. Во втором случае используется пользовательский веб-интерфейс. Прямые способы могут быть разными:

    • вызов внутри программы;
    • использование специальных автоматических тестов и др.

    То есть, вызов напрямую позволяет системе использовать внутренние функции или методы сторонних программ, например, когда приложение будет отправлять запрос на получение информации из других приложений. Причём в этом случае можно использовать ручной вызов без задействования графического интерфейса.

    Упрощённо для вызова API сайта данные на сервер отправляются в виде URL-запроса. Причём если код закрытый, дополнительно потребуется отдельное подключение API-ключа.

    Почему разработчики используют API

    Основная задача API – быть промежуточным слоем между двумя сайтами или приложениями и позволить им обмениваться информацией. API может быть публичным, например, такие используют популярные платформы наподобие YouTube. Бывают частными – их разрабатывают для определённых пользователей или аудитории, например, для работы внутри предприятия. Чтобы начать работу с ним, нужно получить доступ – здесь будет закрытый код.

    Для разработчиков программный интерфейс необходим, чтобы:

    • сократить время работы и упростить создание продуктов – они используют готовые API;
    • обеспечить безопасность – скрывать некоторые функции в отдельных приложениях;
    • максимально просто настраивать связи между программами и сервисами, не привлекая непосредственно создателей сторонних приложений при работе над собственным продуктом;
    • сократить бюджет за счёт того, что не нужно разрабатывать всё с нуля самостоятельно, а можно пользоваться готовыми решениями.

    Например, когда не существовало Windows, разработчикам приходилось создавать все окна на экране ПК самостоятельно и писать огромный объём кода. Когда появился API Windows, эта же работа стала занимать несколько минут.

    API необходим и бизнесу. Без него было бы невозможно проводить транзакции, например, принимать оплату с банковских карт, развивать приложения, внедрять инновационные решения и обеспечить необходимую безопасность некоторых процессов.

    Особенности современного API

    1. Попытка унификации формата. Уже сейчас в основном используют запросы HTTP и REST.
    2. Статус отдельного продукта. API становится «самостоятельным», хотя пользуются им только разработчики. Сейчас это уже достаточно предсказуемая программа, имеющая собственную поддержку и получающая регулярные обновления версий.
    3. Увеличение количества программных интерфейсов. Практически у всех крупных приложений есть API, что значительно облегчает взаимодействие с ними. При этом крупные корпорации уделяют много внимания обеспечению безопасности функций.

    Кроме того, подход к созданию API становится более серьезным – проводятся тестирования, контроль версий после выхода продукта.

    Источник: www.vbr.ru

Рейтинг
( Пока оценок нет )
Загрузка ...
Заработок в интернете или как начать работать дома