Contactless API - Revision history

Mahong at 09:59, 23 August 2019

2019-08-23T09:59:16Z

← Older revision		Revision as of 09:59, 23 August 2019
Line 1:		Line 1:
	== API Overview==		== API Overview==
	* For CPU card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#attach_target\|attach_target]]>[[#transmit\|transmit]]>[[#detach_target\|detach_target]]>[[#close\|close]],but Felica		* For CPU card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#attach_target\|attach_target]]>[[#transmit\|transmit]]>[[#detach_target\|detach_target]]>[[#close\|close]],but Felica card don't need to do attach.
	card don't need to do attach.
	* For memory card such as Mifare1 card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#verify\|verify]]>[[#read\|read]] or [[#write\|write]]>[[#close\|close]]		* For memory card such as Mifare1 card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#verify\|verify]]>[[#read\|read]] or [[#write\|write]]>[[#close\|close]]
	* For electronic wallet card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#verify\|verify]]>[[#read_value\|read_value]] or [[#write_value\|write_value]] or [increment/decrement]>[[#transfer\|transfer]]>[[#close\|close]], the [increment/decrement] includes the flows:[[#restore\|restore]]>[[#increment\|increment]]/[[#decrement\|decrement]]>[[#transfer\|transfer]].		* For electronic wallet card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#verify\|verify]]>[[#read_value\|read_value]] or [[#write_value\|write_value]] or [increment/decrement]>[[#transfer\|transfer]]>[[#close\|close]], the [increment/decrement] includes the flows:[[#restore\|restore]]>[[#increment\|increment]]/[[#decrement\|decrement]]>[[#transfer\|transfer]].

Mahong at 03:19, 11 March 2019

2019-03-11T03:19:48Z

← Older revision		Revision as of 03:19, 11 March 2019
Line 1:		Line 1:
	== API Overview==		== API Overview==
	* For CPU card, the follow ~~api~~ calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#attach_target\|attach_target]]>[[#transmit\|transmit]]>[[#detach_target\|detach_target]]>[[#close\|close]],but ~~Filicard~~ don't need to do attach.		* For CPU card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#attach_target\|attach_target]]>[[#transmit\|transmit]]>[[#detach_target\|detach_target]]>[[#close\|close]],but Felica
	* For memory card such as Mifare1 card, the follow ~~api~~ calling sequence is [[#open\|open]]>[[#~~search_target_bego in~~\|search_target_begin]]>[[#verify\|verify]]>[[#read\|read]] or [[#write\|write]]>[[#close\|close]]		card don't need to do attach.
	* For ~~eletronic~~ wallet card, the follow ~~api~~ calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#verify\|verify]]>[[#read_value\|read_value]] or [[#write_value\|write_value]] or [increment/decrement]>[[#transfer\|transfer]]>[[#close\|close]], the [increment/decrement] includes the flows:[[#restore\|restore]]>[[#increment\|increment]]/[[#decrement\|decrement]]>[[#transfer\|transfer]].		* For memory card such as Mifare1 card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#verify\|verify]]>[[#read\|read]] or [[#write\|write]]>[[#close\|close]]
			* For electronic wallet card, the follow API calling sequence is [[#open\|open]]>[[#search_target_begin\|search_target_begin]]>[[#verify\|verify]]>[[#read_value\|read_value]] or [[#write_value\|write_value]] or [increment/decrement]>[[#transfer\|transfer]]>[[#close\|close]], the [increment/decrement] includes the flows:[[#restore\|restore]]>[[#increment\|increment]]/[[#decrement\|decrement]]>[[#transfer\|transfer]].
	=== <big>open</big> ===		=== <big>open</big> ===
	<syntaxhighlight lang="c">void* contactless_card_open(CONTACTLESS_CARD_NOTIFIER fNotifier, void* pUserData, int* pErrorCode)</syntaxhighlight >		<syntaxhighlight lang="c">void* contactless_card_open(CONTACTLESS_CARD_NOTIFIER fNotifier, void* pUserData, int* pErrorCode)</syntaxhighlight >
Line 61:		Line 62:
	<syntaxhighlight lang="c">int contactless_card_search_target_end(int nHandle)</syntaxhighlight >		<syntaxhighlight lang="c">int contactless_card_search_target_end(int nHandle)</syntaxhighlight >
	Stop the process of searching card.		Stop the process of searching card.
	The [[#search_target_begin\|search_target_begin]] and [[#search_target_end\|search_target_end]] ~~apis~~ are pair operations.		The [[#search_target_begin\|search_target_begin]] and [[#search_target_end\|search_target_end]] API are pair operations.

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 148:		Line 149:
	<syntaxhighlight lang="c">int contactless_card_attach_target(int nHandle, unsigned char* pATRBuffer, unsigned int nATRBufferLength)</syntaxhighlight >		<syntaxhighlight lang="c">int contactless_card_attach_target(int nHandle, unsigned char* pATRBuffer, unsigned int nATRBufferLength)</syntaxhighlight >
	Attach the target before transmitting APDU command. In this process, the target(card) is activated and return ATR.		Attach the target before transmitting APDU command. In this process, the target(card) is activated and return ATR.
	If the card is a CPU card, the [[#attach_target\|attach_target]], [[#detach_target\|detach_target]] and [[#transmit\|transmit]] ~~apis~~ are used to get ~~informations~~ from the card.		If the card is a CPU card, the [[#attach_target\|attach_target]], [[#detach_target\|detach_target]] and [[#transmit\|transmit]] API are used to get information from the card.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 175:		Line 176:
	<syntaxhighlight lang="c">int contactless_card_detach_target(int nHandle)</syntaxhighlight >		<syntaxhighlight lang="c">int contactless_card_detach_target(int nHandle)</syntaxhighlight >
	Detach the target. If you want to send APDU again, you should attach it.		Detach the target. If you want to send APDU again, you should attach it.
	The detach is a block method, only when you remove the card can you get the return value of this ~~api~~.		The detach is a block method, only when you remove the card can you get the return value of this API.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 260:		Line 261:
	<syntaxhighlight lang="c">int contactless_card_mc_verify_pin(int nHandle, unsigned int nSectorIndex, unsigned int nPinType, unsigned char* strPin, unsigned int nPinLength)</syntaxhighlight >		<syntaxhighlight lang="c">int contactless_card_mc_verify_pin(int nHandle, unsigned int nSectorIndex, unsigned int nPinType, unsigned char* strPin, unsigned int nPinLength)</syntaxhighlight >
	Verify the key of the contactless card. You should firstly know the key and corresponding key type(key A or key B).		Verify the key of the contactless card. You should firstly know the key and corresponding key type(key A or key B).
	If the card is a Mifare card, the [[#verify\|verify]], [[#read\|read]] and [[#write\|write]] ~~apis~~ are used to get ~~informations~~ from the card.		If the card is a Mifare card, the [[#verify\|verify]], [[#read\|read]] and [[#write\|write]] API are used to get information from the card.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 351:		Line 352:
	<syntaxhighlight lang="c">int contactless_card_mc_write_value(int nHandle, unsigned int nSectorIndex, unsigned int nBlockIndex, unsigned char* pValue, unsigned int nValueLength, unsigned char pAddrData)</syntaxhighlight >		<syntaxhighlight lang="c">int contactless_card_mc_write_value(int nHandle, unsigned int nSectorIndex, unsigned int nBlockIndex, unsigned char* pValue, unsigned int nValueLength, unsigned char pAddrData)</syntaxhighlight >
	Write money value and user data to the specified block if the card is an electronic wallet format card.		Write money value and user data to the specified block if the card is an electronic wallet format card.
	This ~~api~~ will format the MC card as an electronic wallet format card. If you want to use the following ~~apis~~, you should firstly confirm that the card is an electronic wallet format card.		This API will format the MC card as an electronic wallet format card. If you want to use the following API, you should firstly confirm that the card is an electronic wallet format card.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 414:		Line 415:
	=== <big>increment</big> ===		=== <big>increment</big> ===
	<syntaxhighlight lang="c">int contactless_card_mc_increment(int nHandle, unsigned int nSectorIndex, unsigned int nBlockIndex, unsigned char* pValue, unsigned int nValueLength)</syntaxhighlight >		<syntaxhighlight lang="c">int contactless_card_mc_increment(int nHandle, unsigned int nSectorIndex, unsigned int nBlockIndex, unsigned char* pValue, unsigned int nValueLength)</syntaxhighlight >
	Increase value to a block. This ~~api~~ should be used with restore and transfer.		Increase value to a block. This API should be used with restore and transfer.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 444:		Line 445:
	=== <big>decrement</big>===		=== <big>decrement</big>===
	<syntaxhighlight lang="c">int contactless_card_mc_decrement(int nHandle, unsigned int nSectorIndex, unsigned int nBlockIndex, unsigned char* pValue, unsigned int nValueLength)</syntaxhighlight >		<syntaxhighlight lang="c">int contactless_card_mc_decrement(int nHandle, unsigned int nSectorIndex, unsigned int nBlockIndex, unsigned char* pValue, unsigned int nValueLength)</syntaxhighlight >
	Decrease value to a block. This ~~api~~ should be used with restore and transfer.		Decrease value to a block. This API should be used with restore and transfer.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-

Mahong at 06:43, 11 January 2019

2019-01-11T06:43:37Z

← Older revision		Revision as of 06:43, 11 January 2019
Line 225:		Line 225:
	\|}		\|}

			=== <big>transmit_level3</big> ===
			<syntaxhighlight lang="c">int contactless_card_transmit_level3(int nHandle, unsigned char* pAPDU, unsigned int nAPDULength, unsigned char* pResponse, unsigned int *pResponseLength, int nOperationValue)</syntaxhighlight >
			Transmit APDU command and get the response. This is only for ultralight C card.
			The APDU command of contactless card is the same as the IC card normally.
			{\|class="wizarpostable"
			\|-
			! scope="row" colspan="2"\| Parameters
			\|-
			\| nHandle \|\| '''int:''' Handle of this device, returned from open
			\|-
			\| pAPDU \|\| '''unsigned char*:''' Command of APDU
			\|-
			\| nAPDULength \|\| '''unsigned int:''' Length of command
			\|-
			\| pResponse \|\| '''unsigned char*:''' Response buffer of APDU command
			\|-
			\| pResponseLength \|\| '''unsigned int:''' buffer length of response
			\|-
			\| nOperationValue\|\| '''int:''' reserved for future, must be set to zero
			\|}
			{\|
			\|-
			\|
			\|}

			{\|class="wizarpostable"
			\|-
			! scope="row" colspan="2"\| Returns
			\|-
			\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
			\|}

	=== <big>verify</big> ===		=== <big>verify</big> ===

Mahong: /* verify */

2019-01-11T06:40:50Z

verify

← Older revision		Revision as of 06:40, 11 January 2019
Line 238:		Line 238:
	\| nSectorIndex \|\| '''unsigned int:''' Sector index		\| nSectorIndex \|\| '''unsigned int:''' Sector index
	\|-		\|-
	\| nPinType \|\| '''unsigned int:''' Key type:0—Key A; 1—Key B		\| nPinType \|\| '''unsigned int:''' Key type:0—Key A; 1—Key B; 2-TDEA type (for ultralight C)
	\|-		\|-
	\| strPin \|\| '''unsigned char*:''' Password of this sector		\| strPin \|\| '''unsigned char*:''' Password of this sector
Line 255:		Line 255:
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>read</big> ===		=== <big>read</big> ===

Mahong: /* open */

2018-05-03T02:13:49Z

open

← Older revision		Revision as of 02:13, 3 May 2018
Line 24:		Line 24:
	! scope="row" colspan="2"\| Returns		! scope="row" colspan="2"\| Returns
	\|-		\|-
	\| int \|\| The result code, != 0, success, value is the handle of contactless card device; <0 failed.		\| int \|\| The result code, != 0, success, value is the handle of contactless card device; =0 failed.
	\|}		\|}


	=== <big>search_target_begin</big> ===		=== <big>search_target_begin</big> ===

Mahong at 06:54, 2 May 2018

2018-05-02T06:54:56Z

← Older revision		Revision as of 06:54, 2 May 2018
Line 16:		Line 16:
	\| pErrorCode\|\| '''int*:''' [[Error_code\|error code]] if return value is equals to 0		\| pErrorCode\|\| '''int*:''' [[Error_code\|error code]] if return value is equals to 0
	\|}		\|}
			{\|
			\|-
			\|
			\|}
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-
Line 68:		Line 70:
	\| nHandle \|\| '''int:''' Handle of this device, returned from open		\| nHandle \|\| '''int:''' Handle of this device, returned from open
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 88:		Line 93:
	\| nHandle \|\| '''int:''' Handle of this device, returned from open		\| nHandle \|\| '''int:''' Handle of this device, returned from open
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 152:		Line 160:
	\| nATRBufferLength \|\| '''int:''' Length of ATR buffer		\| nATRBufferLength \|\| '''int:''' Length of ATR buffer
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 172:		Line 183:
	\| nHandle \|\| '''int:''' Handle of this device, returned from open		\| nHandle \|\| '''int:''' Handle of this device, returned from open
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 200:		Line 214:
	\| pResponseLength \|\| '''unsigned int:''' buffer length of response		\| pResponseLength \|\| '''unsigned int:''' buffer length of response
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 228:		Line 245:
	\| nPinLength \|\| '''unsigned int:''' Length of password		\| nPinLength \|\| '''unsigned int:''' Length of password
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 256:		Line 276:
	\| nDataBufferLength \|\| '''unsigned int:''' Buffer length		\| nDataBufferLength \|\| '''unsigned int:''' Buffer length
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 283:		Line 306:
	\| nDataLength \|\| '''unsigned int：''' Buffer length		\| nDataLength \|\| '''unsigned int：''' Buffer length
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 313:		Line 339:
	\| pAddrData \|\| '''unsigned char：''' User data		\| pAddrData \|\| '''unsigned char：''' User data
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 341:		Line 370:
	\| pAddrData \|\| '''unsigned char*：''' buffer for saving a user data, 1 byte		\| pAddrData \|\| '''unsigned char*：''' buffer for saving a user data, 1 byte
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 368:		Line 400:
	\| nValueBufLength \|\| '''unsigned int:''' Buffer length, must be greater than 4		\| nValueBufLength \|\| '''unsigned int:''' Buffer length, must be greater than 4
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 395:		Line 430:
	\| nValueBufLength \|\| '''unsigned int:''' Buffer length, must be greater than 4		\| nValueBufLength \|\| '''unsigned int:''' Buffer length, must be greater than 4
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 418:		Line 456:
	\| nBlockIndex \|\|'''unsigned int:''' Block index of the specified sector		\| nBlockIndex \|\|'''unsigned int:''' Block index of the specified sector
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 441:		Line 482:
	\| nBlockIndex \|\| '''unsigned int:''' Block index of the specified sector		\| nBlockIndex \|\| '''unsigned int:''' Block index of the specified sector
	\|}		\|}
			{\|
			\|-
			\|
			\|}

	{\|class="wizarpostable"		{\|class="wizarpostable"

Mahong at 06:39, 2 May 2018

2018-05-02T06:39:23Z

Show changes

Mahong at 05:59, 2 May 2018

2018-05-02T05:59:05Z

Show changes

Mahong at 03:43, 2 May 2018

2018-05-02T03:43:06Z

Show changes

Mahong: /* Functions */

2018-04-18T08:31:40Z

Functions

Show changes